{"components":{"securitySchemes":{"secretKey":{"bearerFormat":"ur_{test|live}_sk_…","scheme":"bearer","type":"http"}}},"info":{"description":"Unirail routes money between your users' accounts across the providers you connect. Authenticate with a secret key; every write accepts an Idempotency-Key.","title":"Unirail API","version":"2026-10-08"},"security":[{"secretKey":[]}],"servers":[{"url":"https://api.unirail.dev"}],"openapi":"3.1.1","paths":{"/v1/rails":{"get":{"operationId":"rails.list","summary":"The provider catalogue: integrated and listed rails","tags":["rails"],"parameters":[{"name":"country","in":"query","schema":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"allowEmptyValue":true,"allowReserved":true},{"name":"status","in":"query","schema":{"enum":["listed","in-development","integrated","certified"],"type":"string"},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"enum":["pisp-aggregator","bank-api","meta-provider","verification","on-chain","data","identity","compliance"],"type":"string"},"status":{"enum":["listed","in-development","integrated","certified"],"type":"string"},"summary":{"type":"string"},"website":{"type":"string","format":"uri"},"logoUrl":{"type":"string","format":"uri"},"roles":{"type":"array","items":{"enum":["bank-link","institution-directory","payment","payment-consent","identity-verification","account-verification","webhook","payout","pay-in","fx"],"type":"string"}},"countries":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"}},"schemes":{"type":"array","items":{"type":"string"},"description":"payto schemes it can pay to or from"},"custody":{"type":"array","items":{"enum":["none","payer-own-account","provider-for-user","provider-transit","platform-entity","partner-entity"],"type":"string"}},"regulated":{"type":"string","description":"Who is the regulated party, in plain words"},"onboarding":{"type":"object","properties":{"sandbox":{"enum":["self-serve","on-request","none"],"type":"string"},"production":{"enum":["self-serve","contract","partner-programme"],"type":"string"},"notes":{"type":"string"}},"required":["sandbox","production"]},"credentials":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"secret":{"type":"boolean"},"description":{"type":"string"}},"required":["key","secret","description"]}},"capabilities":{"type":"array","items":{"type":"object","properties":{"id":{"enum":["banking.ais.account-details","banking.ais.balances","banking.ais.transactions","banking.ais.insights","banking.pis.single","banking.pis.scheduled","banking.pis.vrp-sweeping","banking.pis.vrp-commercial","banking.pis.bulk","banking.payouts","banking.pay-ins.virtual-accounts","banking.pay-ins.debit","verification.cop","verification.vop","verification.ownership","verification.micro-deposits","identity.kyc.document","identity.kyc.biometric","identity.kyc.database","identity.kyc.eid","identity.kyb","identity.prefill","compliance.screening.sanctions","compliance.screening.pep","compliance.screening.adverse-media","compliance.screening.payments","compliance.transaction-monitoring","compliance.travel-rule","risk.payment-return","risk.fraud-signals","money.fx","money.cross-border","money.stablecoin-ramp"],"type":"string"},"countries":{"type":"array","minItems":1,"items":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"}},"status":{"enum":["integrated","listed","planned"],"type":"string"},"source":{"type":"string","format":"uri"},"checkedAt":{"type":"string","format":"date"},"notes":{"type":"string"}},"required":["id","countries","status"]}}},"required":["id","name","kind","status","summary","website","roles","countries","schemes","custody","regulated","onboarding","credentials"]}}},"required":["data"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/addresses/parse":{"post":{"operationId":"addresses.parse","summary":"Validate and mask a payto:// address without storing it","tags":["addresses"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"payto":{"type":"string","minLength":9,"maxLength":2048}},"required":["payto"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"scheme":{"type":"string"},"known":{"type":"boolean","description":"False when the scheme is valid payto but not one Unirail models yet"},"masked":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"receiverName":{"type":"string"}},"required":["scheme","known","masked"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/institutions":{"get":{"operationId":"institutions.list","summary":"Banks reachable through this environment's connections","tags":["institutions"],"parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"allowEmptyValue":true,"allowReserved":true},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":80},"allowEmptyValue":true,"allowReserved":true},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^ins_[A-Za-z0-9]{8,64}$","description":"ins_… identifier"},"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"logoUrl":{"type":"string","format":"uri"},"providers":{"type":"array","items":{"type":"object","properties":{"rail":{"type":"string"},"connection":{"type":"string","pattern":"^con_[A-Za-z0-9]{8,64}$","description":"con_… identifier"},"roles":{"type":"array","items":{"enum":["bank-link","institution-directory","payment","payment-consent","identity-verification","account-verification","webhook","payout","pay-in","fx"],"type":"string"}},"rank":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["rail","connection","roles","rank"]}},"restrictions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]}}},"required":["id","name","country","providers","restrictions"]}}},"required":["data"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/customers":{"post":{"operationId":"customers.create","summary":"Create or return the customer for your user id","tags":["customers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"externalId":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":140},"email":{"type":"string","format":"email"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"}},"required":["externalId"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"object":{"const":"customer"},"externalId":{"type":"string","description":"Your user id; unique per environment"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","externalId","metadata","createdAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}},"get":{"operationId":"customers.list","tags":["customers"],"parameters":[{"name":"externalId","in":"query","schema":{"type":"string"},"allowEmptyValue":true,"allowReserved":true},{"name":"after","in":"query","schema":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"allowEmptyValue":true,"allowReserved":true},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"object":{"const":"customer"},"externalId":{"type":"string","description":"Your user id; unique per environment"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","externalId","metadata","createdAt"]}},"hasMore":{"type":"boolean"},"next":{"type":"string"}},"required":["data","hasMore"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/customers/{id}":{"get":{"operationId":"customers.retrieve","tags":["customers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"object":{"const":"customer"},"externalId":{"type":"string","description":"Your user id; unique per environment"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","externalId","metadata","createdAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/link_sessions":{"post":{"operationId":"linkSessions.create","summary":"Start linking a customer's bank account","tags":["link sessions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"},"institution":{"type":"string","pattern":"^ins_[A-Za-z0-9]{8,64}$","description":"ins_… identifier"},"rail":{"type":"string"},"channel":{"enum":["web","native"],"type":"string","default":"web"},"returnUri":{"type":"string","format":"uri","description":"Where the user lands after the provider step; your app's URL or universal link"},"psu":{"type":"object","properties":{"ip":{"type":"string","maxLength":64},"userAgent":{"type":"string","maxLength":512},"deviceId":{"type":"string","maxLength":128},"psuType":{"enum":["personal","business"],"type":"string"}}}},"required":["customer","country","returnUri"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^lnk_[A-Za-z0-9]{8,64}$","description":"lnk_… identifier"},"object":{"const":"link_session"},"customer":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"institution":{"type":"string","pattern":"^ins_[A-Za-z0-9]{8,64}$","description":"ins_… identifier"},"rail":{"type":"string"},"status":{"enum":["requires_action","processing","completed","failed","cancelled","expired"],"type":"string"},"nextAction":{"anyOf":[{"type":"object","properties":{"kind":{"const":"redirect"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"sdk"},"provider":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","provider","token"]},{"type":"object","properties":{"kind":{"const":"decoupled"},"message":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","message"]},{"type":"object","properties":{"kind":{"const":"qr"},"payload":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","payload"]},{"type":"object","properties":{"kind":{"const":"app-handoff"},"url":{"type":"string","format":"uri"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"funding-instructions"},"payto":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","payto","reference","amount"]},{"type":"object","properties":{"kind":{"const":"form"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"enum":["text","select"],"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","label","type"]}}},"required":["kind","fields"]},{"type":"object","properties":{"kind":{"const":"add-payee-in-bank"},"instructions":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","instructions"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},"disclosures":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"accounts":{"type":"array","items":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"}},"failure":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]},"expiresAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","customer","rail","status","disclosures","accounts","expiresAt","createdAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/link_sessions/{id}/advance":{"post":{"operationId":"linkSessions.advance","summary":"Continue after the user returns from the provider","tags":["link sessions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^lnk_[A-Za-z0-9]{8,64}$","description":"lnk_… identifier"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"returnParams":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"sdkResult":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^lnk_[A-Za-z0-9]{8,64}$","description":"lnk_… identifier"},"object":{"const":"link_session"},"customer":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"institution":{"type":"string","pattern":"^ins_[A-Za-z0-9]{8,64}$","description":"ins_… identifier"},"rail":{"type":"string"},"status":{"enum":["requires_action","processing","completed","failed","cancelled","expired"],"type":"string"},"nextAction":{"anyOf":[{"type":"object","properties":{"kind":{"const":"redirect"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"sdk"},"provider":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","provider","token"]},{"type":"object","properties":{"kind":{"const":"decoupled"},"message":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","message"]},{"type":"object","properties":{"kind":{"const":"qr"},"payload":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","payload"]},{"type":"object","properties":{"kind":{"const":"app-handoff"},"url":{"type":"string","format":"uri"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"funding-instructions"},"payto":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","payto","reference","amount"]},{"type":"object","properties":{"kind":{"const":"form"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"enum":["text","select"],"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","label","type"]}}},"required":["kind","fields"]},{"type":"object","properties":{"kind":{"const":"add-payee-in-bank"},"instructions":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","instructions"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},"disclosures":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"accounts":{"type":"array","items":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"}},"failure":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]},"expiresAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","customer","rail","status","disclosures","accounts","expiresAt","createdAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/link_sessions/{id}":{"get":{"operationId":"linkSessions.retrieve","tags":["link sessions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^lnk_[A-Za-z0-9]{8,64}$","description":"lnk_… identifier"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^lnk_[A-Za-z0-9]{8,64}$","description":"lnk_… identifier"},"object":{"const":"link_session"},"customer":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"institution":{"type":"string","pattern":"^ins_[A-Za-z0-9]{8,64}$","description":"ins_… identifier"},"rail":{"type":"string"},"status":{"enum":["requires_action","processing","completed","failed","cancelled","expired"],"type":"string"},"nextAction":{"anyOf":[{"type":"object","properties":{"kind":{"const":"redirect"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"sdk"},"provider":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","provider","token"]},{"type":"object","properties":{"kind":{"const":"decoupled"},"message":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","message"]},{"type":"object","properties":{"kind":{"const":"qr"},"payload":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","payload"]},{"type":"object","properties":{"kind":{"const":"app-handoff"},"url":{"type":"string","format":"uri"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"funding-instructions"},"payto":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","payto","reference","amount"]},{"type":"object","properties":{"kind":{"const":"form"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"enum":["text","select"],"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","label","type"]}}},"required":["kind","fields"]},{"type":"object","properties":{"kind":{"const":"add-payee-in-bank"},"instructions":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","instructions"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},"disclosures":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"accounts":{"type":"array","items":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"}},"failure":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]},"expiresAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","customer","rail","status","disclosures","accounts","expiresAt","createdAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/accounts":{"post":{"operationId":"accounts.create","summary":"Register account details a payee gave you (not linked through a provider)","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"holderName":{"type":"string","minLength":1,"maxLength":140},"payto":{"type":"string","minLength":9,"maxLength":2048},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"}},"required":["holderName","payto"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"object":{"const":"account"},"customer":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"holder":{"type":"object","properties":{"kind":{"enum":["user","platform-entity","partner-entity","provider"],"type":"string"},"name":{"type":"string"}},"required":["kind"]},"institution":{"type":"object","properties":{"id":{"type":"string","pattern":"^ins_[A-Za-z0-9]{8,64}$","description":"ins_… identifier"},"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"}},"required":["name","country"]},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"},"addresses":{"type":"array","minItems":1,"items":{"type":"object","properties":{"scheme":{"type":"string"},"masked":{"type":"string","description":"e.g. •••• 0008"},"fingerprint":{"type":"string","description":"Keyed hash; equal fingerprints mean the same account details"},"verification":{"type":"object","properties":{"status":{"enum":["unverified","verified","mismatch","failed"],"type":"string"},"source":{"enum":["own-link","cop","aisp-ownership","micro-deposit","proxy-lookup","entered"],"type":"string"},"verifiedAt":{"type":"string","format":"date-time"}},"required":["status","source"]}},"required":["scheme","masked","fingerprint","verification"]}},"link":{"type":"string","pattern":"^lnk_[A-Za-z0-9]{8,64}$","description":"lnk_… identifier"},"status":{"enum":["active","reauth-required","revoked"],"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"direction":{"enum":["send","receive"],"type":"string"},"rail":{"type":"string"},"allowed":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]}}},"required":["direction","rail","allowed","reasons"]}},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","holder","asset","addresses","status","capabilities","metadata","createdAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}},"get":{"operationId":"accounts.list","tags":["accounts"],"parameters":[{"name":"customer","in":"query","schema":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"allowEmptyValue":true,"allowReserved":true},{"name":"after","in":"query","schema":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"allowEmptyValue":true,"allowReserved":true},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"object":{"const":"account"},"customer":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"holder":{"type":"object","properties":{"kind":{"enum":["user","platform-entity","partner-entity","provider"],"type":"string"},"name":{"type":"string"}},"required":["kind"]},"institution":{"type":"object","properties":{"id":{"type":"string","pattern":"^ins_[A-Za-z0-9]{8,64}$","description":"ins_… identifier"},"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"}},"required":["name","country"]},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"},"addresses":{"type":"array","minItems":1,"items":{"type":"object","properties":{"scheme":{"type":"string"},"masked":{"type":"string","description":"e.g. •••• 0008"},"fingerprint":{"type":"string","description":"Keyed hash; equal fingerprints mean the same account details"},"verification":{"type":"object","properties":{"status":{"enum":["unverified","verified","mismatch","failed"],"type":"string"},"source":{"enum":["own-link","cop","aisp-ownership","micro-deposit","proxy-lookup","entered"],"type":"string"},"verifiedAt":{"type":"string","format":"date-time"}},"required":["status","source"]}},"required":["scheme","masked","fingerprint","verification"]}},"link":{"type":"string","pattern":"^lnk_[A-Za-z0-9]{8,64}$","description":"lnk_… identifier"},"status":{"enum":["active","reauth-required","revoked"],"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"direction":{"enum":["send","receive"],"type":"string"},"rail":{"type":"string"},"allowed":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]}}},"required":["direction","rail","allowed","reasons"]}},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","holder","asset","addresses","status","capabilities","metadata","createdAt"]}},"hasMore":{"type":"boolean"},"next":{"type":"string"}},"required":["data","hasMore"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/accounts/{id}":{"get":{"operationId":"accounts.retrieve","tags":["accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"object":{"const":"account"},"customer":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"holder":{"type":"object","properties":{"kind":{"enum":["user","platform-entity","partner-entity","provider"],"type":"string"},"name":{"type":"string"}},"required":["kind"]},"institution":{"type":"object","properties":{"id":{"type":"string","pattern":"^ins_[A-Za-z0-9]{8,64}$","description":"ins_… identifier"},"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2"}},"required":["name","country"]},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"},"addresses":{"type":"array","minItems":1,"items":{"type":"object","properties":{"scheme":{"type":"string"},"masked":{"type":"string","description":"e.g. •••• 0008"},"fingerprint":{"type":"string","description":"Keyed hash; equal fingerprints mean the same account details"},"verification":{"type":"object","properties":{"status":{"enum":["unverified","verified","mismatch","failed"],"type":"string"},"source":{"enum":["own-link","cop","aisp-ownership","micro-deposit","proxy-lookup","entered"],"type":"string"},"verifiedAt":{"type":"string","format":"date-time"}},"required":["status","source"]}},"required":["scheme","masked","fingerprint","verification"]}},"link":{"type":"string","pattern":"^lnk_[A-Za-z0-9]{8,64}$","description":"lnk_… identifier"},"status":{"enum":["active","reauth-required","revoked"],"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"direction":{"enum":["send","receive"],"type":"string"},"rail":{"type":"string"},"allowed":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]}}},"required":["direction","rail","allowed","reasons"]}},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","object","holder","asset","addresses","status","capabilities","metadata","createdAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/route_quotes":{"post":{"operationId":"routeQuotes.create","summary":"Find and price the routes between two accounts","tags":["payments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"preference":{"enum":["cheapest","fastest","recommended"],"type":"string"},"preferRail":{"type":"string"},"channel":{"enum":["web","native"],"type":"string","default":"web"}},"required":["from","to","amount"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"quotes":{"type":"array","maxItems":3,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^qt_[A-Za-z0-9]{8,64}$","description":"qt_… identifier"},"object":{"const":"route_quote"},"label":{"enum":["cheapest","fastest","recommended"],"type":"string"},"legs":{"type":"array","minItems":1,"items":{"type":"object","properties":{"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"rail":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"custodyAfter":{"enum":["none","payer-own-account","provider-for-user","provider-transit","platform-entity","partner-entity"],"type":"string"},"userActions":{"type":"array","items":{"type":"string"}}},"required":["from","to","rail","amount","custodyAfter","userActions"]}},"totalCost":{"type":"object","properties":{"payer":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"breakdown":{"type":"array","items":{"type":"object","properties":{"kind":{"enum":["provider","bank","platform","fx-spread","network"],"type":"string"},"paidBy":{"enum":["payer","payee","platform"],"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","paidBy","amount"]}}},"required":["payer","breakdown"]},"eta":{"type":"object","properties":{"p50Seconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"p90Seconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["p50Seconds","p90Seconds"]},"successLikelihood":{"type":"number","minimum":0,"maximum":1},"obligations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"stage":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","stage","explanation"]}},"restrictionsApplied":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]}},"firmness":{"enum":["firm","indicative"],"type":"string"},"digest":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["id","object","legs","totalCost","eta","successLikelihood","obligations","restrictionsApplied","firmness","digest","expiresAt"]}},"infeasible":{"type":"array","items":{"type":"object","properties":{"rail":{"type":"string"},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"reasons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]}}},"required":["rail","from","to","reasons"]}},"suggestion":{"enum":["link-another-account"],"type":"string"}},"required":["quotes","infeasible"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/payment_intents":{"post":{"operationId":"paymentIntents.create","summary":"Pay along an accepted quote","tags":["payments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quote":{"type":"string","pattern":"^qt_[A-Za-z0-9]{8,64}$","description":"qt_… identifier"},"digest":{"type":"string"},"returnUri":{"type":"string","format":"uri","description":"Where the user lands after the provider step; your app's URL or universal link"},"reference":{"type":"string","maxLength":140},"psu":{"type":"object","properties":{"ip":{"type":"string","maxLength":64},"userAgent":{"type":"string","maxLength":512},"deviceId":{"type":"string","maxLength":128},"psuType":{"enum":["personal","business"],"type":"string"}}},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"}},"required":["quote","digest","returnUri"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"},"object":{"const":"payment_intent"},"status":{"enum":["requires_action","processing","succeeded","failed","cancelled"],"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"quote":{"type":"string","pattern":"^qt_[A-Za-z0-9]{8,64}$","description":"qt_… identifier"},"reference":{"type":"string"},"legs":{"type":"array","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^leg_[A-Za-z0-9]{8,64}$","description":"leg_… identifier"},"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"rail":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"custodyAfter":{"enum":["none","payer-own-account","provider-for-user","provider-transit","platform-entity","partner-entity"],"type":"string"},"state":{"enum":["created","awaiting-user","awaiting-step-up","awaiting-submit","awaiting-funds","blocked-on-information","submitted","accepted","confirming","credited","unconfirmed","attested","failed","cancelled","refunded","returned"],"type":"string"},"providerRef":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","sequence","from","to","rail","amount","custodyAfter","state","updatedAt"]}},"nextAction":{"anyOf":[{"type":"object","properties":{"kind":{"const":"redirect"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"sdk"},"provider":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","provider","token"]},{"type":"object","properties":{"kind":{"const":"decoupled"},"message":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","message"]},{"type":"object","properties":{"kind":{"const":"qr"},"payload":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","payload"]},{"type":"object","properties":{"kind":{"const":"app-handoff"},"url":{"type":"string","format":"uri"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"funding-instructions"},"payto":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","payto","reference","amount"]},{"type":"object","properties":{"kind":{"const":"form"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"enum":["text","select"],"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","label","type"]}}},"required":["kind","fields"]},{"type":"object","properties":{"kind":{"const":"add-payee-in-bank"},"instructions":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","instructions"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},"failure":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","object","status","amount","from","to","quote","legs","metadata","createdAt","updatedAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}},"get":{"operationId":"paymentIntents.list","tags":["payments"],"parameters":[{"name":"customer","in":"query","schema":{"type":"string","pattern":"^cus_[A-Za-z0-9]{8,64}$","description":"cus_… identifier"},"allowEmptyValue":true,"allowReserved":true},{"name":"after","in":"query","schema":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"},"allowEmptyValue":true,"allowReserved":true},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"},"object":{"const":"payment_intent"},"status":{"enum":["requires_action","processing","succeeded","failed","cancelled"],"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"quote":{"type":"string","pattern":"^qt_[A-Za-z0-9]{8,64}$","description":"qt_… identifier"},"reference":{"type":"string"},"legs":{"type":"array","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^leg_[A-Za-z0-9]{8,64}$","description":"leg_… identifier"},"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"rail":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"custodyAfter":{"enum":["none","payer-own-account","provider-for-user","provider-transit","platform-entity","partner-entity"],"type":"string"},"state":{"enum":["created","awaiting-user","awaiting-step-up","awaiting-submit","awaiting-funds","blocked-on-information","submitted","accepted","confirming","credited","unconfirmed","attested","failed","cancelled","refunded","returned"],"type":"string"},"providerRef":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","sequence","from","to","rail","amount","custodyAfter","state","updatedAt"]}},"nextAction":{"anyOf":[{"type":"object","properties":{"kind":{"const":"redirect"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"sdk"},"provider":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","provider","token"]},{"type":"object","properties":{"kind":{"const":"decoupled"},"message":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","message"]},{"type":"object","properties":{"kind":{"const":"qr"},"payload":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","payload"]},{"type":"object","properties":{"kind":{"const":"app-handoff"},"url":{"type":"string","format":"uri"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"funding-instructions"},"payto":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","payto","reference","amount"]},{"type":"object","properties":{"kind":{"const":"form"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"enum":["text","select"],"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","label","type"]}}},"required":["kind","fields"]},{"type":"object","properties":{"kind":{"const":"add-payee-in-bank"},"instructions":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","instructions"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},"failure":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","object","status","amount","from","to","quote","legs","metadata","createdAt","updatedAt"]}},"hasMore":{"type":"boolean"},"next":{"type":"string"}},"required":["data","hasMore"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/payment_intents/{id}":{"get":{"operationId":"paymentIntents.retrieve","tags":["payments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"},"object":{"const":"payment_intent"},"status":{"enum":["requires_action","processing","succeeded","failed","cancelled"],"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"quote":{"type":"string","pattern":"^qt_[A-Za-z0-9]{8,64}$","description":"qt_… identifier"},"reference":{"type":"string"},"legs":{"type":"array","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^leg_[A-Za-z0-9]{8,64}$","description":"leg_… identifier"},"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"rail":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"custodyAfter":{"enum":["none","payer-own-account","provider-for-user","provider-transit","platform-entity","partner-entity"],"type":"string"},"state":{"enum":["created","awaiting-user","awaiting-step-up","awaiting-submit","awaiting-funds","blocked-on-information","submitted","accepted","confirming","credited","unconfirmed","attested","failed","cancelled","refunded","returned"],"type":"string"},"providerRef":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","sequence","from","to","rail","amount","custodyAfter","state","updatedAt"]}},"nextAction":{"anyOf":[{"type":"object","properties":{"kind":{"const":"redirect"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"sdk"},"provider":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","provider","token"]},{"type":"object","properties":{"kind":{"const":"decoupled"},"message":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","message"]},{"type":"object","properties":{"kind":{"const":"qr"},"payload":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","payload"]},{"type":"object","properties":{"kind":{"const":"app-handoff"},"url":{"type":"string","format":"uri"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"funding-instructions"},"payto":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","payto","reference","amount"]},{"type":"object","properties":{"kind":{"const":"form"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"enum":["text","select"],"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","label","type"]}}},"required":["kind","fields"]},{"type":"object","properties":{"kind":{"const":"add-payee-in-bank"},"instructions":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","instructions"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},"failure":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","object","status","amount","from","to","quote","legs","metadata","createdAt","updatedAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/payment_intents/{id}/advance":{"post":{"operationId":"paymentIntents.advance","summary":"Continue after the user returns from approving","tags":["payments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"returnParams":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"sdkResult":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"},"object":{"const":"payment_intent"},"status":{"enum":["requires_action","processing","succeeded","failed","cancelled"],"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"quote":{"type":"string","pattern":"^qt_[A-Za-z0-9]{8,64}$","description":"qt_… identifier"},"reference":{"type":"string"},"legs":{"type":"array","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^leg_[A-Za-z0-9]{8,64}$","description":"leg_… identifier"},"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"rail":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"custodyAfter":{"enum":["none","payer-own-account","provider-for-user","provider-transit","platform-entity","partner-entity"],"type":"string"},"state":{"enum":["created","awaiting-user","awaiting-step-up","awaiting-submit","awaiting-funds","blocked-on-information","submitted","accepted","confirming","credited","unconfirmed","attested","failed","cancelled","refunded","returned"],"type":"string"},"providerRef":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","sequence","from","to","rail","amount","custodyAfter","state","updatedAt"]}},"nextAction":{"anyOf":[{"type":"object","properties":{"kind":{"const":"redirect"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"sdk"},"provider":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","provider","token"]},{"type":"object","properties":{"kind":{"const":"decoupled"},"message":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","message"]},{"type":"object","properties":{"kind":{"const":"qr"},"payload":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","payload"]},{"type":"object","properties":{"kind":{"const":"app-handoff"},"url":{"type":"string","format":"uri"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"funding-instructions"},"payto":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","payto","reference","amount"]},{"type":"object","properties":{"kind":{"const":"form"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"enum":["text","select"],"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","label","type"]}}},"required":["kind","fields"]},{"type":"object","properties":{"kind":{"const":"add-payee-in-bank"},"instructions":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","instructions"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},"failure":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","object","status","amount","from","to","quote","legs","metadata","createdAt","updatedAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/payment_intents/{id}/cancel":{"post":{"operationId":"paymentIntents.cancel","tags":["payments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^pi_[A-Za-z0-9]{8,64}$","description":"pi_… identifier"},"object":{"const":"payment_intent"},"status":{"enum":["requires_action","processing","succeeded","failed","cancelled"],"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"quote":{"type":"string","pattern":"^qt_[A-Za-z0-9]{8,64}$","description":"qt_… identifier"},"reference":{"type":"string"},"legs":{"type":"array","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^leg_[A-Za-z0-9]{8,64}$","description":"leg_… identifier"},"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"from":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"to":{"type":"string","pattern":"^acct_[A-Za-z0-9]{8,64}$","description":"acct_… identifier"},"rail":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]},"custodyAfter":{"enum":["none","payer-own-account","provider-for-user","provider-transit","platform-entity","partner-entity"],"type":"string"},"state":{"enum":["created","awaiting-user","awaiting-step-up","awaiting-submit","awaiting-funds","blocked-on-information","submitted","accepted","confirming","credited","unconfirmed","attested","failed","cancelled","refunded","returned"],"type":"string"},"providerRef":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","sequence","from","to","rail","amount","custodyAfter","state","updatedAt"]}},"nextAction":{"anyOf":[{"type":"object","properties":{"kind":{"const":"redirect"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"sdk"},"provider":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","provider","token"]},{"type":"object","properties":{"kind":{"const":"decoupled"},"message":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","message"]},{"type":"object","properties":{"kind":{"const":"qr"},"payload":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["kind","payload"]},{"type":"object","properties":{"kind":{"const":"app-handoff"},"url":{"type":"string","format":"uri"}},"required":["kind","url"]},{"type":"object","properties":{"kind":{"const":"funding-instructions"},"payto":{"type":"string"},"reference":{"type":"string"},"amount":{"type":"object","properties":{"value":{"type":"string","pattern":"^(0|[1-9][0-9]{0,30})$"},"asset":{"type":"string","pattern":"^(iso4217:[A-Z]{3}|[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128})$"}},"required":["value","asset"]}},"required":["kind","payto","reference","amount"]},{"type":"object","properties":{"kind":{"const":"form"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"enum":["text","select"],"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["name","label","type"]}}},"required":["kind","fields"]},{"type":"object","properties":{"kind":{"const":"add-payee-in-bank"},"instructions":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["kind","instructions"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},"failure":{"type":"object","properties":{"code":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code","explanation"]},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Up to 20 keys you can use to find objects again"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","object","status","amount","from","to","quote","legs","metadata","createdAt","updatedAt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/events":{"get":{"operationId":"events.list","summary":"Events in order; walk with `after` to replay anything a webhook missed","tags":["events"],"parameters":[{"name":"after","in":"query","schema":{"type":"string","pattern":"^evt_[A-Za-z0-9]{8,64}$","description":"evt_… identifier"},"allowEmptyValue":true,"allowReserved":true},{"name":"type","in":"query","schema":{"enum":["link_session.completed","link_session.failed","account.updated","account.reauth_required","payment_intent.requires_action","payment_intent.processing","payment_intent.succeeded","payment_intent.failed","payment_intent.cancelled","leg.updated","connection.degraded"],"type":"string"},"allowEmptyValue":true,"allowReserved":true},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^evt_[A-Za-z0-9]{8,64}$","description":"evt_… identifier"},"object":{"const":"event"},"type":{"enum":["link_session.completed","link_session.failed","account.updated","account.reauth_required","payment_intent.requires_action","payment_intent.processing","payment_intent.succeeded","payment_intent.failed","payment_intent.cancelled","leg.updated","connection.degraded"],"type":"string"},"mode":{"enum":["test","live"],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"data":{"type":"object","properties":{"object":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object"]}},"required":["id","object","type","mode","createdAt","data"]}},"hasMore":{"type":"boolean"},"next":{"type":"string"}},"required":["data","hasMore"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}},"/v1/events/{id}":{"get":{"operationId":"events.retrieve","tags":["events"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^evt_[A-Za-z0-9]{8,64}$","description":"evt_… identifier"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^evt_[A-Za-z0-9]{8,64}$","description":"evt_… identifier"},"object":{"const":"event"},"type":{"enum":["link_session.completed","link_session.failed","account.updated","account.reauth_required","payment_intent.requires_action","payment_intent.processing","payment_intent.succeeded","payment_intent.failed","payment_intent.cancelled","leg.updated","connection.degraded"],"type":"string"},"mode":{"enum":["test","live"],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"data":{"type":"object","properties":{"object":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object"]}},"required":["id","object","type","mode","createdAt","data"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Bad Request"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"Unauthorized"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"Forbidden"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"Not Found"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"Conflict"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"422":{"description":"422","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNPROCESSABLE_CONTENT"},"status":{"const":422},"message":{"type":"string","default":"Unprocessable Content"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too Many Requests"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"502":{"description":"502","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_GATEWAY"},"status":{"const":502},"message":{"type":"string","default":"Bad Gateway"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"503":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"SERVICE_UNAVAILABLE"},"status":{"const":503},"message":{"type":"string","default":"Service Unavailable"},"data":{"type":"object","properties":{"code":{"enum":["invalid_request","unauthorized","forbidden","not_found","idempotency_conflict","quote_expired","quote_changed","route_infeasible","connection_not_ready","provider_unavailable","provider_rejected","rate_limited"],"type":"string"},"param":{"type":"string"},"requestId":{"type":"string"},"explanation":{"type":"object","properties":{"key":{"type":"string"},"vars":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"message":{"type":"string"}},"required":["key","vars","message"]}},"required":["code"]}},"required":["defined","code","status","message","data"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}}}}}}