{
"openapi": "3.0.3",
"info": {
"title": "Checkout",
"description": "Checkout support a buyer's shopping journey, enabling them to receive and purchase products through personalized payment agreement options",
"version": "2.0.0",
"contact": {
"email": "partnership-growth@getbread.com"
}
},
"servers": [
{
"url": "https://api-preview.platform.breadpayments.com/",
"description": "Preview environment"
},
{
"url": "https://api.platform.breadpayments.com/",
"description": "Production environment"
}
],
"paths": {
"/api/application": {
"get": {
"tags": [
"Application"
],
"summary": "List Applications by Filter",
"description": "Allows a consumer to list all Applications within their user scope (e.g. Tenants, Buyers and Merchants can only retrieve their own Applications). By providing query parameters, the list results can be filtered.\n\nUpon success, a paginated list of relevant Applications will be returned. If no Applications were found with the provided filters, the response will be 200 OK with an empty array of Applications.\n\n**JWT Claim Authorization:**\n**TenantID**: Required (non-nil); scopes results to the caller's tenant.\n**MerchantID**: Optional; if present in token and a `merchantID` query filter is also provided, they must match or the request is rejected. If present in token, applied as a filter.\n**ProgramID**: Optional; if present in token, applied as a filter.\n**BuyerID**: Optional; if present in token, limits results to the caller's own applications.",
"operationId": "listApplications",
"parameters": [
{
"name": "buyerID.eq",
"in": "query",
"description": "The unique identifier of the Buyer.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "merchantID.eq",
"in": "query",
"description": "The unique identifier of the Merchant. Must match merchantID on the JWT if provided.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "status.eq",
"in": "query",
"description": "The status to filter the Application records by.",
"required": false,
"schema": {
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
},
{
"name": "statusCode.eq",
"in": "query",
"description": "The status code to filter the Application records by.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "array",
"minItems": 0,
"items": {
"type": "string",
"pattern": "^[0-9]{6}$",
"example": "030101"
}
}
},
{
"name": "statusCode.ne",
"in": "query",
"description": "The status code that don't match to filter the Application records by.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "array",
"minItems": 0,
"items": {
"type": "string",
"pattern": "^[0-9]{6}$",
"example": "030101"
}
}
},
{
"name": "showExpired.eq",
"in": "query",
"required": false,
"description": "Show expired applications. Defaults to true.",
"schema": {
"type": "boolean"
}
},
{
"name": "normalizedAddressHash.eq",
"in": "query",
"required": false,
"description": "Show applications associated with provided normalized address hash.",
"schema": {
"type": "string",
"format": "sha256"
}
},
{
"name": "metadata.eq",
"in": "query",
"description": "Show metadata associated with the application. Defaults to false.",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "updatedAt.gte",
"in": "query",
"description": "The lower bound of the date range, inclusive.",
"required": false,
"schema": {
"type": "string",
"format": "YYYY-MM-DD"
}
},
{
"name": "updatedAt.lte",
"in": "query",
"description": "The upper bound of the date range, inclusive.",
"required": false,
"schema": {
"type": "string",
"format": "YYYY-MM-DD"
}
},
{
"name": "lastTimestamp.eq",
"in": "query",
"description": "The timestamp value formatted per RFC3339 of the last Application from the previous page, used for keyset pagination. Depends on whether createdAt or updatedAt is used for sorting.",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T20:44:29.057144-04:00"
}
},
{
"name": "lastID.eq",
"in": "query",
"description": "The unique identifier of the last ID from the previous page, used for keyset pagination.",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"example": "652ee2a3-7b25-431b-bd22-0490db77c444"
}
},
{
"name": "sort",
"in": "query",
"description": "Specifies the sort order for paginated results. Accepts createdAt or updatedAt fields with ascending or descending order.",
"required": false,
"schema": {
"type": "string",
"enum": [
"createdAt.asc",
"createdAt.desc",
"updatedAt.asc",
"updatedAt.desc"
]
}
},
{
"in": "query",
"name": "limit",
"description": "The maximum number of records that will be returned in a result set.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 200,
"default": 10
},
"example": 50
},
{
"in": "query",
"name": "offset",
"description": "The number of records to skip before starting to collect the result set. Used in conjunction with limit query parameter for pagination support",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0
},
"example": 20
}
],
"security": [
{
"bearerAuthApplication": [
"r:application"
]
}
],
"responses": {
"200": {
"description": "The list of Applications including pagination.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applications": {
"description": "The list of Applications that satisfy the provided filtering and scope conditions.",
"type": "array",
"items": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"pagination": {
"description": "The pagination information used to query.",
"type": "object",
"properties": {
"limit": {
"description": "The limit value used.",
"type": "string",
"example": "10"
},
"offset": {
"description": "The offset value used.",
"type": "string",
"example": "0"
},
"lastTimestamp": {
"description": "The timestamp value formatted per RFC3339 of the last Application from the previous page, used for keyset pagination. Depends on whether createdAt or updatedAt is used for sorting.",
"type": "string",
"format": "date-time",
"example": "2025-12-31T20:44:29.057144-04:00"
},
"lastID": {
"description": "The unique identifier of the last Application from the previous page, used for keyset pagination.",
"type": "string",
"format": "uuid",
"example": "652ee2a3-7b25-431b-bd22-0490db77c444"
},
"total": {
"description": "The total count of applications found in the database, if any.",
"type": "string",
"example": "1"
}
}
}
}
}
}
}
},
"400": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"429": {
"description": "The caller has exceeded the allowed request rate. Retry after a short back-off period.",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 429,
"message": "Too many requests.",
"domain": "Application",
"metadata": {},
"reason": "Too_Many_Requests"
}
}
}
},
"500": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"503": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
}
}
},
"post": {
"tags": [
"Application"
],
"summary": "Start an Application",
"description": "Allows a Buyer to create an Application.\n\nUpon success, the details of the created Application will be returned. Possible Application statuses include INELIGIBLE, NEEDS_ACTION, DENIED and APPROVED. Any of these statuses will result in a 201 Created response - the client must check the status field in the response body.\n\nApproved Applications will have one or more Payment Agreements that can be presented to the Buyer to Checkout.\n\nFor instore applications, a locationID key-value pair must be present as an extension.\n\n**JWT Claim Authorization:**\n**TenantID**: Required (non-nil); set as the application's `tenantID`.\n**MerchantID**: Optional; resolved from token or request body and set as the application's `merchantID`.\n**ProgramID**: Optional; resolved from token or request body and set as the application's `programID`.\n**BuyerID**: Optional; set as the application's `buyerID`.",
"operationId": "startApplication",
"security": [
{
"bearerAuthApplication": [
"c:application"
]
}
],
"requestBody": {
"description": "The body of a request necessary to apply for an Application.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Start Request",
"required": [
"order",
"disclosures"
],
"properties": {
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Optional unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Optional unique identifier of the Program."
},
"order": {
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
},
"disclosures": {
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
},
"example": [
{
"type": "test-type",
"acceptedAt": "2021-02-24T17:15:43Z",
"checksum": ""
}
]
},
"extensions": {
"type": "array",
"items": {
"type": "object",
"title": "Extension",
"description": "An array of optional key-value pairs.",
"properties": {
"key": {
"type": "string",
"description": "The name of key.",
"example": "locationID"
},
"value": {
"type": "string",
"description": "The value corresponding to the key.",
"example": "1234"
}
}
},
"example": [
{
"key": "locationID",
"value": "e88b1bf0-7c05-4614-bf36-5d39b2c80556"
}
]
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"prescreenID": {
"type": "string",
"description": "Optional identifier of a prescreen"
},
"affiliate": {
"type": "string",
"description": "Optional identifier of the source of a prescreen call"
}
}
}
}
}
},
"responses": {
"201": {
"description": "The Application as a response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
}
}
},
"400": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"404": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"422": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"429": {
"description": "The caller has exceeded the allowed request rate. Retry after a short back-off period.",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 429,
"message": "Too many requests.",
"domain": "Application",
"metadata": {},
"reason": "Too_Many_Requests"
}
}
}
},
"500": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"503": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
}
}
}
},
"/api/application/{applicationID}": {
"get": {
"tags": [
"Application"
],
"summary": "Get Application by ID",
"description": "Allows a consumer to retrieve an Application by supplying an Application ID.\n\nUpon success, the Application details will be returned. Access is limited by user scope (e.g. Tenants, Buyers and Merchants can only retrieve their own Applications).\n\n**JWT Claim Authorization:**\n**TenantID**: Required (non-nil); cross-tenant access is not permitted.\n**MerchantID**: Optional; if present in token, validated against the application. A mismatch returns 404.\n**ProgramID**: Optional; if present in token, validated against the application. A mismatch returns 404.\n**BuyerID**: Optional; if present in token, validated against the application. A mismatch returns 404.",
"operationId": "getApplication",
"parameters": [
{
"name": "applicationID",
"in": "path",
"required": true,
"description": "The unique identifier of the Application.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"security": [
{
"bearerAuthApplication": [
"r:application"
]
}
],
"responses": {
"200": {
"description": "The Application as a response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
}
}
},
"400": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"404": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"429": {
"description": "The caller has exceeded the allowed request rate. Retry after a short back-off period.",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 429,
"message": "Too many requests.",
"domain": "Application",
"metadata": {},
"reason": "Too_Many_Requests"
}
}
}
},
"500": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"503": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
}
}
}
},
"/api/application/{applicationID}/agreement/{agreementID}/checkout": {
"post": {
"tags": [
"Application"
],
"summary": "Complete Checkout for Application",
"description": "Allows a Buyer to submit a selected Payment Agreement in order to complete a Transaction and check out with a Merchant.\n\nUpon success, the updated Application details will be returned. Possible Application statuses include CANCELLED, NEEDS_ACTION, DENIED and CHECKOUT_COMPLETED. Any of these statuses will result in a 200 OK response - the client must check the status field in the response body.\n\nAn application with status NEEDS_ACTION and statusCode 070201 indicates that the payment method was declined and the Buyer is allowed to retry Checkout with a new paymentMethodID.\n\nIn the event that the BuyerHash Check fails when attempting to complete a checkout, the application will be marked with status CANCELLED and statusCode 010101.\n\nUpon completed checkout, a Transaction record is generated for the Merchant and the Buyer's Checkout is now complete.\n\n**JWT Claim Authorization:**\n**TenantID**: Required (non-nil); set as the checkout request's `tenantID`.\n**MerchantID**: Optional; if present in token, validated against the application during checkout.\n**ProgramID**: Optional; if present in token, validated against the application during checkout.\n**BuyerID**: Optional; if present in token, validated against the application during checkout.",
"operationId": "checkoutApplication",
"parameters": [
{
"name": "applicationID",
"in": "path",
"required": true,
"description": "The unique identifier of the Application.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agreementID",
"in": "path",
"required": true,
"description": "The unique identifier of the Payment Agreement.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"security": [
{
"bearerAuthApplication": [
"c:checkout"
]
}
],
"requestBody": {
"description": "The body of a request necessary to complete a checkout for an Application.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Checkout Request",
"required": [
"order",
"disclosures"
],
"properties": {
"order": {
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
},
"disclosures": {
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
},
"example": [
{
"type": "test-type",
"acceptedAt": "2021-02-24T17:15:43Z",
"checksum": ""
}
]
},
"ipAddress": {
"type": "string",
"description": "The IP Address of the device that the Buyer is using to checkout this Application.",
"example": "127.0.0.11"
},
"buyerShippingContactID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the shipping contact for the associated Buyer. Required for non-DEBT_CONSOLIDATION checkouts"
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the payment method created for down payment. Required for checking out with payment products that have type equal to SPLITPAY."
},
"autoPaymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the payment method created for auto pay enrollment. Optional for checking out with payment products that have type equal to INSTALLMENTS."
},
"clientInfo": {
"title": "ClientInfo",
"type": "array",
"description": "Generic client information for use in backend services",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Key under which information can be retrieved for the integrated backend vendor"
},
"value": {
"type": "string",
"description": "Client information for the associated key."
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "The Application as a response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
}
}
},
"400": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"404": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"422": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"429": {
"description": "The caller has exceeded the allowed request rate. Retry after a short back-off period.",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 429,
"message": "Too many requests.",
"domain": "Application",
"metadata": {},
"reason": "Too_Many_Requests"
}
}
}
},
"500": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"503": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
}
}
}
},
"/api/application/{applicationID}/prepare-checkout": {
"post": {
"tags": [
"Application"
],
"summary": "Prepare Checkout for Application",
"description": "Allows a Buyer to submit offers/terms for an Application to prepare a checkout in a Merchant store.\n\nThis runs BOF for use by the Checkout Experience, without completing application checkout.\n\nA short code will be generated and linked to the created application and selected offer.\n\n Application status will be updated to ATTEMPTED_PREPARE_CHECKOUT, and finally CHECKOUT_PREPARED after actual application checkout.\n\nIn the event that the BuyerHash Check fails when attempting to prepare a checkout, the application will be marked with status CANCELLED and statusCode 010101.\n\n**JWT Claim Authorization:**\n**TenantID**: Required (non-nil); set as the prepare request's `tenantID`.\n**MerchantID**: Optional; if present in token, included in the prepare request.\n**ProgramID**: Optional; if present in token, included in the prepare request.\n**BuyerID**: Optional; if present in token, included in the prepare request.",
"operationId": "prepareApplication",
"parameters": [
{
"name": "applicationID",
"in": "path",
"required": true,
"description": "The unique identifier of the Application.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"security": [
{
"bearerAuthApplication": [
"c:checkout"
]
}
],
"requestBody": {
"description": "The body of a request necessary to prepare a checkout for an Application.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Prepare Checkout Request",
"required": [
"order",
"disclosures",
"paymentAgreementID"
],
"properties": {
"order": {
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
},
"disclosures": {
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
},
"example": [
{
"type": "test-type",
"acceptedAt": "2021-02-24T17:15:43Z",
"checksum": ""
}
]
},
"ipAddress": {
"type": "string",
"description": "The IP Address of the device that the Buyer is using to checkout this Application.",
"example": "127.0.0.11"
},
"paymentAgreementID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the payment method created for down payment. Required for checking out with payment products that have type equal to SPLITPAY."
},
"clientInfo": {
"title": "ClientInfo",
"type": "array",
"description": "Generic client information for use in backend services",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Key under which information can be retrieved for the integrated backend vendor"
},
"value": {
"type": "string",
"description": "Client information for the associated key."
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"serviceType": {
"title": "ServiceType",
"type": "string",
"enum": [
"MATERIALS",
"SERVICE",
"BOTH"
]
},
"serviceContactID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the service contact for the associated Buyer."
}
}
}
}
}
},
"responses": {
"200": {
"description": "The Application as a response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
}
}
},
"400": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"404": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"422": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"429": {
"description": "The caller has exceeded the allowed request rate. Retry after a short back-off period.",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 429,
"message": "Too many requests.",
"domain": "Application",
"metadata": {},
"reason": "Too_Many_Requests"
}
}
}
},
"500": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"503": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
}
}
}
},
"/api/application/instore/{shortcode}/checkout": {
"post": {
"tags": [
"Application"
],
"summary": "Complete Checkout for Instore Application",
"description": "Allows a Buyer to submit a generated short code in order to complete a Transaction and checkout with a Merchant.\n\nUpon success, the updated Application details will be returned. Possible Application statuses include CANCELLED and CHECKOUT_COMPLETED. Any of these statuses will result in a 200 OK response - the client must check the status field in the response body.\n\nIn the event that the BuyerHash Check fails when attempting to complete a checkout for an Instore Application, the application will be marked with status CANCELLED and statusCode 010101.\n\nUpon completed checkout, a Transaction record is generated for the Merchant and the Buyer's Checkout is now complete.\n\n**JWT Claim Authorization:**\n**TenantID**: Required (non-nil); set as the application's `tenantID`.\n**MerchantID**: Required (non-nil); must be present in the token for this request to proceed.\n**ProgramID**: Required (non-nil); must be present in the token for this request to proceed.\n**BuyerID**: Optional; set as the application's `buyerID` if present.",
"operationId": "checkoutInstoreApplication",
"parameters": [
{
"name": "shortcode",
"in": "path",
"required": true,
"description": "The short code for an instore application.",
"schema": {
"type": "string",
"pattern": "^[A-Z0-9]{6}$",
"example": "A1B2C3"
}
}
],
"security": [
{
"bearerAuthApplication": [
"c:instore"
]
}
],
"requestBody": {
"description": "The body of a request necessary to complete an instore checkout for an Application",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Instore Checkout Request",
"required": [
"order",
"disclosures",
"merchant"
],
"properties": {
"order": {
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
},
"disclosures": {
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
},
"example": [
{
"type": "test-type",
"acceptedAt": "2021-02-24T17:15:43Z",
"checksum": ""
}
]
},
"merchant": {
"type": "object",
"properties": {
"locationReferenceID": {
"type": "string",
"description": "External reference identifier of the store location."
},
"orderID": {
"type": "string",
"description": "External reference identifier of the order."
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "The Application as a response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
}
}
},
"400": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"404": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"422": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"429": {
"description": "The caller has exceeded the allowed request rate. Retry after a short back-off period.",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 429,
"message": "Too many requests.",
"domain": "Application",
"metadata": {},
"reason": "Too_Many_Requests"
}
}
}
},
"500": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"503": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
}
}
}
},
"/api/virtual-card/issuance": {
"post": {
"tags": [
"Virtual Card"
],
"summary": "Issue a new virtual card",
"description": "Begins the issuance process for a new virtual card.",
"operationId": "issueVirtualCard",
"security": [
{
"bearerAuthVirtualCard": [
"c:vc.issuance"
]
}
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"scopeID",
"scopeType",
"buyerID",
"programID"
],
"properties": {
"scopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"scopeID": {
"description": "Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"programID": {
"description": "ID of the program associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"buyerID": {
"description": "ID of the buyer associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"applicationSettings": {
"description": "Additional metadata if the scopeType is APPLICATION.",
"type": "object",
"properties": {
"merchantID": {
"description": "ID of the merchant associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "e3b1d6f5-bc6a-4835-b40e-5f1a22dacf6a"
}
},
"example": {
"merchantID": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
}
},
"example": {
"scopeType": "APPLICATION",
"scopeID": "a2b1fa94-98fc-4de3-9b76-7c0de89fcbb1",
"programID": "0efc5a37-96fe-4636-9966-bf3ab26c3f29",
"buyerID": "c1c1fdd1-811c-4ea2-bf37-2af9ea348299",
"applicationSettings": {
"merchantID": "e3b1d6f5-bc6a-4835-b40e-5f1a22dacf6a"
}
}
}
}
},
"description": "Virtual card issuance request",
"required": true
},
"responses": {
"200": {
"description": "The updated issuance information.",
"content": {
"application/json": {
"schema": {
"description": "Information on the current issuance.",
"type": "object",
"required": [
"issuance"
],
"properties": {
"issuance": {
"description": "Issuance data",
"type": "object",
"required": [
"id",
"status",
"scopeType",
"scopeID"
],
"properties": {
"id": {
"description": "Issuance id",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"status": {
"description": "Provisioning status of the issuance.\n`REQUESTED` represents a requested but not yet issued card.\n`PROCESSING` represents a provisioning issuance.\n`ISSUED` represents a provisioned issuance.\n`FAILED` represents an issuance that failed to provision.\n`CLOSED` represents an issuance that has gone through checkout and can no longer be modified.",
"type": "string",
"enum": [
"REQUESTED",
"PROCESSING",
"ISSUED",
"FAILED",
"CLOSED"
],
"example": "ISSUED"
},
"scopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"scopeID": {
"description": "Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"buyerID": {
"description": "Buyer ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"programID": {
"description": "Program ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"tenantID": {
"description": "Tenant ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"paymentProductID": {
"description": "Payment Product ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"applicationSettings": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"applicationID"
],
"properties": {
"applicationID": {
"description": "ID of the application associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantID": {
"description": "ID of the merchant associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantLocationID": {
"description": "ID of the merchant location associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"offerID": {
"description": "ID of the offer associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"posCheckoutCapability": {
"type": "array",
"description": "Array of checkout options that are available at point of sale",
"items": {
"type": "string",
"enum": [
"TapToPay",
"KeyEntry"
]
},
"example": [
"TapToPay",
"KeyEntry"
]
}
},
"example": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"example": {
"id": "b55438f7-c616-45da-ba46-a9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"card": {
"description": "Card information",
"type": "object",
"required": [
"cardID",
"status"
],
"properties": {
"cardToken": {
"description": "Card token.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"lastFour": {
"description": "Last 4 digits of the card number. Added once card is provisioned.",
"type": "string",
"example": "1234"
},
"status": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
},
"expiry": {
"description": "Expiration datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"issuanceDate": {
"description": "Issuance datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-01T21:23:27Z"
},
"pan": {
"description": "Card PAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"cvv": {
"description": "Card CVV. Only available with r:vc.restricted scope.",
"type": "string",
"example": "123"
},
"capacity": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"card_type": {
"description": "SINGLE_USE or MULTI_USE",
"type": "string",
"enum": [
"SINGLE_USE",
"MULTI_USE"
],
"example": "SINGLE_USE"
}
},
"example": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
},
"card_type": "SINGLE_USE"
}
},
"wallets": {
"description": "Wallets associated with the virtual card.",
"type": "array",
"items": {
"description": "Wallet information",
"type": "object",
"required": [
"id",
"type",
"status",
"usedAtCheckout",
"error"
],
"properties": {
"id": {
"description": "Wallet id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"type": {
"description": "Type of wallet.",
"type": "string",
"enum": [
"APPLEPAY",
"GOOGLEPAY"
],
"example": "GOOGLEPAY"
},
"status": {
"description": "Provisioning status of a digital wallet token.\n`PROVISIONING` represents a digital wallet token in the process of provisioning.\n`ACTIVE` represents a successfully provisioned digital wallet token.\n`FAILED` represents a digital wallet token that failed provisioning.\n`SUSPENDED` represents a suspended digital wallet token. Can be reinstated.\n`TERMINATED` represents a terminated digital wallet token. Cannot be reinstated.",
"type": "string",
"enum": [
"PROVISIONING",
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED"
],
"example": "ACTIVE"
},
"dpan": {
"description": "Wallet DPAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"usedAtCheckout": {
"description": "True if this wallet was used for checkout.",
"type": "boolean",
"example": true
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
},
"applePay": {
"description": "ApplePay wallet information",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "Unique state associated with the wallet.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
},
"example": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
},
"googlePay": {
"description": "GooglePay wallet information",
"type": "object",
"required": [
"publicWalletId",
"publicDeviceId"
],
"properties": {
"publicWalletId": {
"description": "GooglePay public wallet id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
},
"publicDeviceId": {
"description": "GooglePay public device id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"example": {
"publicWalletId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd",
"publicDeviceId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
}
},
"example": {
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"dpan": "1234567812345678",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
}
},
"summary": {
"description": "Total authorized/settled/refunded transactions.",
"type": "object",
"required": [
"authorized",
"settled",
"refunded"
],
"properties": {
"authorized": {
"description": "Total authorized transaction.",
"type": "number",
"example": 123.45
},
"settled": {
"description": "Total settled transaction.",
"type": "number",
"example": 123.45
},
"refunded": {
"description": "Total refunded transaction.",
"type": "number",
"example": 123.45
}
},
"example": {
"authorized": 123.45,
"settled": 123.45,
"refunded": 123.45
}
},
"transactions": {
"description": "List of transactions in descending order from when they were received",
"type": "array",
"items": {
"description": "Transaction type and token",
"type": "object",
"required": [
"type",
"token",
"status",
"date"
],
"properties": {
"type": {
"description": "Transaction type.",
"type": "string",
"example": "AUTHORIZATION",
"enum": [
"AUTHORIZATION",
"AUTHORIZATION_CLEARING",
"REFUND",
"AUTHORIZATION_REVERSAL",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
]
},
"token": {
"description": "Transaction token.",
"type": "string",
"example": "12345adsv9n2"
},
"status": {
"description": "Transaction status.",
"type": "string",
"example": "PENDING"
},
"date": {
"description": "Transaction date.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"walletID": {
"description": "Digital wallet token ID used at checkout. If empty, a wallet was not used at checkout.",
"type": "string",
"format": "string",
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
},
"example": {
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z",
"walletID": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
}
}
},
"example": {
"issuance": {
"id": "b55438f7-c616-45da-ba46-b9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
},
"card": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
}
},
"wallets": [
{
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
],
"summary": {
"authorized": 0,
"settled": 0,
"refunded": 0
},
"transactions": [
{
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z"
},
{
"type": "AUTHORIZATION_CLEARING",
"token": "183hgn2948ng294pn5g",
"status": "COMPLETION",
"date": "2022-06-08T21:23:27Z"
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/wallet/applepay": {
"post": {
"tags": [
"Virtual Card"
],
"summary": "Issue a new ApplePay digital wallet token",
"description": "Begins the issuance process for a new ApplePay wallet.",
"operationId": "issueApplePay",
"security": [
{
"bearerAuthVirtualCard": [
"c:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"description": "ApplePay issuance request",
"type": "object",
"properties": {},
"example": {}
}
}
},
"description": "ApplePay digital token issuance request",
"required": true
},
"responses": {
"200": {
"description": "The updated issuance information.",
"content": {
"application/json": {
"schema": {
"description": "Response from a digital wallet issuance request.",
"type": "object",
"properties": {
"state": {
"description": "Unique state associated with the wallet. Added to payload if ApplePay wallet was provisioned.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"jws": {
"type": "object",
"required": [
"header",
"payload",
"protected",
"signature"
],
"properties": {
"header": {
"type": "object",
"required": [
"kid"
],
"properties": {
"kid": {
"type": "string",
"example": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c",
"description": "The ID for the JWS Public Key of the key pair used to generate signature."
}
}
},
"protected": {
"type": "string",
"example": "Encoding-BASE64URL(UTF8(Value)): {\n \"alg\": \"ES256\",\n \"cty\": \"application/credential;charset=utf-8\",\n \"typ\": \"JOSE+JSON\"\n \"x5t#S256\":\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\"\n}",
"description": "JWS Protected Headers, contains the Header Parameters that are integrity protected by the JWS Signature."
},
"payload": {
"type": "string",
"example": "Encoding-BASE64URL(Value): {\n \"jti\": \"491e392a-b03b-422d-900b-7f8e268f9718\",\n \"lid\": \"en-US\",\n \"iss\": \"ORG-ffffffff-abcd-1234-7890-ffffffffffff\",\n \"sub\": \"provisioningTarget\"\n \"aud\": \"Apple\",\n \"exp\": 1640341542706,\n \"iat\": 1640337942706,\n \"cti\": \"5c4e4dea-a841-4614-8990-eb172328317a\",\n}",
"description": "JWS payload which includes the message to be sent."
},
"signature": {
"type": "string",
"example": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w",
"description": "JWS Signature"
}
},
"example": {
"header": {
"kid": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c"
},
"payload": "Encoding-BASE64URL(Value): {\\n \\\"jti\\\": \\\"491e392a-b03b-422d-900b-7f8e268f9718\\\",\\n \\\"lid\\\": \\\"en-US\\\",\\n \\\"iss\\\": \\\"ORG-ffffffff-abcd-1234-7890-ffffffffffff\\\",\\n \\\"sub\\\": \\\"provisioningTarget\\\"\\n \\\"aud\\\": \\\"Apple\\\",\\n \\\"exp\\\": 1640341542706,\\n \\\"iat\\\": 1640337942706,\\n \\\"cti\\\": \\\"5c4e4dea-a841-4614-8990-eb172328317a\\\",\\n}",
"protected": "Encoding-BASE64URL(UTF8(Value)): {\\n \\\"alg\\\": \\\"ES256\\\",\\n \\\"cty\\\": \\\"application/credential;charset=utf-8\\\",\\n \\\"typ\\\": \\\"JOSE+JSON\\\"\\n \\\"x5t#S256\\\":\\\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\\\"\\n}",
"signature": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w"
}
}
},
"example": {
"state": "d8a265ce-5d9c-4d0b-9edd-401450f78e09",
"jws": {
"header": {
"kid": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c"
},
"payload": "Encoding-BASE64URL(Value): {\\n \\\"jti\\\": \\\"491e392a-b03b-422d-900b-7f8e268f9718\\\",\\n \\\"lid\\\": \\\"en-US\\\",\\n \\\"iss\\\": \\\"ORG-ffffffff-abcd-1234-7890-ffffffffffff\\\",\\n \\\"sub\\\": \\\"provisioningTarget\\\"\\n \\\"aud\\\": \\\"Apple\\\",\\n \\\"exp\\\": 1640341542706,\\n \\\"iat\\\": 1640337942706,\\n \\\"cti\\\": \\\"5c4e4dea-a841-4614-8990-eb172328317a\\\",\\n}",
"protected": "Encoding-BASE64URL(UTF8(Value)): {\\n \\\"alg\\\": \\\"ES256\\\",\\n \\\"cty\\\": \\\"application/credential;charset=utf-8\\\",\\n \\\"typ\\\": \\\"JOSE+JSON\\\"\\n \\\"x5t#S256\\\":\\\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\\\"\\n}",
"signature": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w"
}
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/wallet/googlepay": {
"post": {
"tags": [
"Virtual Card"
],
"summary": "Issue a new GooglePay digital wallet token",
"description": "Begins the issuance process for a new GooglePay wallet.",
"operationId": "issueGooglePay",
"security": [
{
"bearerAuthVirtualCard": [
"c:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"description": "GooglePay issuance request",
"type": "object",
"required": [
"serverSessionId",
"clientSessionId",
"tokenSetting",
"cardSetting",
"publicWalletId",
"publicDeviceId",
"integratorId"
],
"properties": {
"serverSessionId": {
"type": "string",
"example": "8c84fab9-889c-4cb7-a330-accac5799ea5",
"description": "A string that identifies the backend session. Provided by Google pay backend."
},
"clientSessionId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "A string that identifies the client session. Provided by Google pay backend."
},
"tokenSetting": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "1 => Tokenization will be attempted.; 0 => Tokenization will not be attempted.",
"enum": [
0,
1
]
},
"cardSetting": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "1 => FPAN save will be attempted.; 0 => FPAN save will not be attempted.",
"enum": [
0,
1
]
},
"publicWalletId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "String identifying the device-scoped Google Pay wallet that will receive the token. Provided by Google Pay backend."
},
"publicDeviceId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "String identifying the Android device that will receive the token. Provided by Google Pay backend"
},
"integratorId": {
"type": "string",
"example": "ACMEISSUER_1",
"description": "A Google-assigned string that uniquely identifies both the integrator that is initiating the session and the issuer of the payment card."
}
},
"example": {
"serverSessionId": "8c84fab9-889c-4cb7-a330-accac5799ea5",
"clientSessionId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"tokenSetting": 1,
"cardSetting": 1,
"publicWalletId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"publicDeviceId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"integratorId": "ACMEISSUER_1"
}
}
}
},
"description": "GooglePay digital token issuance request",
"required": true
},
"responses": {
"200": {
"description": "The updated issuance information.",
"content": {
"application/json": {
"schema": {
"description": "Response from a digital wallet issuance request.",
"type": "object",
"properties": {
"state": {
"description": "Unique state associated with the wallet. Added to payload if ApplePay wallet was provisioned.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"jws": {
"type": "object",
"required": [
"header",
"payload",
"protected",
"signature"
],
"properties": {
"header": {
"type": "object",
"required": [
"kid"
],
"properties": {
"kid": {
"type": "string",
"example": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c",
"description": "The ID for the JWS Public Key of the key pair used to generate signature."
}
}
},
"protected": {
"type": "string",
"example": "Encoding-BASE64URL(UTF8(Value)): {\n \"alg\": \"ES256\",\n \"cty\": \"application/credential;charset=utf-8\",\n \"typ\": \"JOSE+JSON\"\n \"x5t#S256\":\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\"\n}",
"description": "JWS Protected Headers, contains the Header Parameters that are integrity protected by the JWS Signature."
},
"payload": {
"type": "string",
"example": "Encoding-BASE64URL(Value): {\n \"jti\": \"491e392a-b03b-422d-900b-7f8e268f9718\",\n \"lid\": \"en-US\",\n \"iss\": \"ORG-ffffffff-abcd-1234-7890-ffffffffffff\",\n \"sub\": \"provisioningTarget\"\n \"aud\": \"Apple\",\n \"exp\": 1640341542706,\n \"iat\": 1640337942706,\n \"cti\": \"5c4e4dea-a841-4614-8990-eb172328317a\",\n}",
"description": "JWS payload which includes the message to be sent."
},
"signature": {
"type": "string",
"example": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w",
"description": "JWS Signature"
}
},
"example": {
"header": {
"kid": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c"
},
"payload": "Encoding-BASE64URL(Value): {\\n \\\"jti\\\": \\\"491e392a-b03b-422d-900b-7f8e268f9718\\\",\\n \\\"lid\\\": \\\"en-US\\\",\\n \\\"iss\\\": \\\"ORG-ffffffff-abcd-1234-7890-ffffffffffff\\\",\\n \\\"sub\\\": \\\"provisioningTarget\\\"\\n \\\"aud\\\": \\\"Apple\\\",\\n \\\"exp\\\": 1640341542706,\\n \\\"iat\\\": 1640337942706,\\n \\\"cti\\\": \\\"5c4e4dea-a841-4614-8990-eb172328317a\\\",\\n}",
"protected": "Encoding-BASE64URL(UTF8(Value)): {\\n \\\"alg\\\": \\\"ES256\\\",\\n \\\"cty\\\": \\\"application/credential;charset=utf-8\\\",\\n \\\"typ\\\": \\\"JOSE+JSON\\\"\\n \\\"x5t#S256\\\":\\\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\\\"\\n}",
"signature": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w"
}
}
},
"example": {
"state": "d8a265ce-5d9c-4d0b-9edd-401450f78e09",
"jws": {
"header": {
"kid": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c"
},
"payload": "Encoding-BASE64URL(Value): {\\n \\\"jti\\\": \\\"491e392a-b03b-422d-900b-7f8e268f9718\\\",\\n \\\"lid\\\": \\\"en-US\\\",\\n \\\"iss\\\": \\\"ORG-ffffffff-abcd-1234-7890-ffffffffffff\\\",\\n \\\"sub\\\": \\\"provisioningTarget\\\"\\n \\\"aud\\\": \\\"Apple\\\",\\n \\\"exp\\\": 1640341542706,\\n \\\"iat\\\": 1640337942706,\\n \\\"cti\\\": \\\"5c4e4dea-a841-4614-8990-eb172328317a\\\",\\n}",
"protected": "Encoding-BASE64URL(UTF8(Value)): {\\n \\\"alg\\\": \\\"ES256\\\",\\n \\\"cty\\\": \\\"application/credential;charset=utf-8\\\",\\n \\\"typ\\\": \\\"JOSE+JSON\\\"\\n \\\"x5t#S256\\\":\\\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\\\"\\n}",
"signature": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w"
}
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}": {
"get": {
"tags": [
"Virtual Card"
],
"summary": "Get issuance",
"description": "Retrieve info for the specified issuance.",
"operationId": "getIssuance",
"security": [
{
"bearerAuthVirtualCard": [
"r:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
{
"description": "Additional include data",
"name": "include",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "string",
"enum": [
"SUMMARY",
"TRANSACTIONS",
"LEDGER"
]
},
"example": "TRANSACTIONS"
}
],
"responses": {
"200": {
"description": "The updated issuance information.",
"content": {
"application/json": {
"schema": {
"description": "Information on the current issuance.",
"type": "object",
"required": [
"issuance"
],
"properties": {
"issuance": {
"description": "Issuance data",
"type": "object",
"required": [
"id",
"status",
"scopeType",
"scopeID"
],
"properties": {
"id": {
"description": "Issuance id",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"status": {
"description": "Provisioning status of the issuance.\n`REQUESTED` represents a requested but not yet issued card.\n`PROCESSING` represents a provisioning issuance.\n`ISSUED` represents a provisioned issuance.\n`FAILED` represents an issuance that failed to provision.\n`CLOSED` represents an issuance that has gone through checkout and can no longer be modified.",
"type": "string",
"enum": [
"REQUESTED",
"PROCESSING",
"ISSUED",
"FAILED",
"CLOSED"
],
"example": "ISSUED"
},
"scopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"scopeID": {
"description": "Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"buyerID": {
"description": "Buyer ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"programID": {
"description": "Program ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"tenantID": {
"description": "Tenant ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"paymentProductID": {
"description": "Payment Product ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"applicationSettings": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"applicationID"
],
"properties": {
"applicationID": {
"description": "ID of the application associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantID": {
"description": "ID of the merchant associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantLocationID": {
"description": "ID of the merchant location associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"offerID": {
"description": "ID of the offer associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"posCheckoutCapability": {
"type": "array",
"description": "Array of checkout options that are available at point of sale",
"items": {
"type": "string",
"enum": [
"TapToPay",
"KeyEntry"
]
},
"example": [
"TapToPay",
"KeyEntry"
]
}
},
"example": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"example": {
"id": "b55438f7-c616-45da-ba46-a9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"card": {
"description": "Card information",
"type": "object",
"required": [
"cardID",
"status"
],
"properties": {
"cardToken": {
"description": "Card token.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"lastFour": {
"description": "Last 4 digits of the card number. Added once card is provisioned.",
"type": "string",
"example": "1234"
},
"status": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
},
"expiry": {
"description": "Expiration datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"issuanceDate": {
"description": "Issuance datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-01T21:23:27Z"
},
"pan": {
"description": "Card PAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"cvv": {
"description": "Card CVV. Only available with r:vc.restricted scope.",
"type": "string",
"example": "123"
},
"capacity": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"card_type": {
"description": "SINGLE_USE or MULTI_USE",
"type": "string",
"enum": [
"SINGLE_USE",
"MULTI_USE"
],
"example": "SINGLE_USE"
}
},
"example": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
},
"card_type": "SINGLE_USE"
}
},
"wallets": {
"description": "Wallets associated with the virtual card.",
"type": "array",
"items": {
"description": "Wallet information",
"type": "object",
"required": [
"id",
"type",
"status",
"usedAtCheckout",
"error"
],
"properties": {
"id": {
"description": "Wallet id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"type": {
"description": "Type of wallet.",
"type": "string",
"enum": [
"APPLEPAY",
"GOOGLEPAY"
],
"example": "GOOGLEPAY"
},
"status": {
"description": "Provisioning status of a digital wallet token.\n`PROVISIONING` represents a digital wallet token in the process of provisioning.\n`ACTIVE` represents a successfully provisioned digital wallet token.\n`FAILED` represents a digital wallet token that failed provisioning.\n`SUSPENDED` represents a suspended digital wallet token. Can be reinstated.\n`TERMINATED` represents a terminated digital wallet token. Cannot be reinstated.",
"type": "string",
"enum": [
"PROVISIONING",
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED"
],
"example": "ACTIVE"
},
"dpan": {
"description": "Wallet DPAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"usedAtCheckout": {
"description": "True if this wallet was used for checkout.",
"type": "boolean",
"example": true
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
},
"applePay": {
"description": "ApplePay wallet information",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "Unique state associated with the wallet.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
},
"example": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
},
"googlePay": {
"description": "GooglePay wallet information",
"type": "object",
"required": [
"publicWalletId",
"publicDeviceId"
],
"properties": {
"publicWalletId": {
"description": "GooglePay public wallet id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
},
"publicDeviceId": {
"description": "GooglePay public device id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"example": {
"publicWalletId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd",
"publicDeviceId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
}
},
"example": {
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"dpan": "1234567812345678",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
}
},
"summary": {
"description": "Total authorized/settled/refunded transactions.",
"type": "object",
"required": [
"authorized",
"settled",
"refunded"
],
"properties": {
"authorized": {
"description": "Total authorized transaction.",
"type": "number",
"example": 123.45
},
"settled": {
"description": "Total settled transaction.",
"type": "number",
"example": 123.45
},
"refunded": {
"description": "Total refunded transaction.",
"type": "number",
"example": 123.45
}
},
"example": {
"authorized": 123.45,
"settled": 123.45,
"refunded": 123.45
}
},
"transactions": {
"description": "List of transactions in descending order from when they were received",
"type": "array",
"items": {
"description": "Transaction type and token",
"type": "object",
"required": [
"type",
"token",
"status",
"date"
],
"properties": {
"type": {
"description": "Transaction type.",
"type": "string",
"example": "AUTHORIZATION",
"enum": [
"AUTHORIZATION",
"AUTHORIZATION_CLEARING",
"REFUND",
"AUTHORIZATION_REVERSAL",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
]
},
"token": {
"description": "Transaction token.",
"type": "string",
"example": "12345adsv9n2"
},
"status": {
"description": "Transaction status.",
"type": "string",
"example": "PENDING"
},
"date": {
"description": "Transaction date.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"walletID": {
"description": "Digital wallet token ID used at checkout. If empty, a wallet was not used at checkout.",
"type": "string",
"format": "string",
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
},
"example": {
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z",
"walletID": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
}
}
},
"example": {
"issuance": {
"id": "b55438f7-c616-45da-ba46-b9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
},
"card": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
}
},
"wallets": [
{
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
],
"summary": {
"authorized": 0,
"settled": 0,
"refunded": 0
},
"transactions": [
{
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z"
},
{
"type": "AUTHORIZATION_CLEARING",
"token": "183hgn2948ng294pn5g",
"status": "COMPLETION",
"date": "2022-06-08T21:23:27Z"
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/card": {
"get": {
"tags": [
"Virtual Card"
],
"summary": "Get issuance card",
"description": "Retrieve card info for the specified issuance.",
"operationId": "getIssuanceCard",
"security": [
{
"bearerAuthVirtualCard": [
"r:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
],
"responses": {
"200": {
"description": "The card information associated with lookupKey.",
"content": {
"application/json": {
"schema": {
"description": "Card information",
"type": "object",
"required": [
"cardID",
"status"
],
"properties": {
"cardToken": {
"description": "Card token.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"lastFour": {
"description": "Last 4 digits of the card number. Added once card is provisioned.",
"type": "string",
"example": "1234"
},
"status": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
},
"expiry": {
"description": "Expiration datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"issuanceDate": {
"description": "Issuance datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-01T21:23:27Z"
},
"pan": {
"description": "Card PAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"cvv": {
"description": "Card CVV. Only available with r:vc.restricted scope.",
"type": "string",
"example": "123"
},
"capacity": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"card_type": {
"description": "SINGLE_USE or MULTI_USE",
"type": "string",
"enum": [
"SINGLE_USE",
"MULTI_USE"
],
"example": "SINGLE_USE"
}
},
"example": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
},
"card_type": "SINGLE_USE"
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/card/pan": {
"get": {
"tags": [
"Virtual Card"
],
"summary": "Get issuance card with PAN and CVV",
"description": "Retrieve card info for the specified issuance with PAN and CVV.",
"operationId": "getIssuanceCardPan",
"security": [
{
"bearerAuthVirtualCard": [
"r:vc.restricted"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
],
"responses": {
"200": {
"description": "The card information with PAN and CVV associated with lookupKey.",
"content": {
"application/json": {
"schema": {
"description": "Card information",
"type": "object",
"required": [
"cardID",
"status"
],
"properties": {
"cardToken": {
"description": "Card token.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"lastFour": {
"description": "Last 4 digits of the card number. Added once card is provisioned.",
"type": "string",
"example": "1234"
},
"status": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
},
"expiry": {
"description": "Expiration datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"issuanceDate": {
"description": "Issuance datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-01T21:23:27Z"
},
"pan": {
"description": "Card PAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"cvv": {
"description": "Card CVV. Only available with r:vc.restricted scope.",
"type": "string",
"example": "123"
},
"capacity": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"card_type": {
"description": "SINGLE_USE or MULTI_USE",
"type": "string",
"enum": [
"SINGLE_USE",
"MULTI_USE"
],
"example": "SINGLE_USE"
}
},
"example": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
},
"card_type": "SINGLE_USE"
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/card/{cardId}/reprovision": {
"post": {
"tags": [
"Virtual Card"
],
"summary": "Reprovision a card",
"description": "Deactivates existing card and issues a new one using the same lookup key. Used when a card is lost, stolen or other reasons.",
"operationId": "reprovisionVirtualCard",
"security": [
{
"bearerAuthVirtualCard": [
"c:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
{
"description": "Card ID",
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
],
"responses": {
"201": {
"description": "The updated issuance information.",
"content": {
"application/json": {
"schema": {
"description": "Information on the current issuance.",
"type": "object",
"required": [
"issuance"
],
"properties": {
"issuance": {
"description": "Issuance data",
"type": "object",
"required": [
"id",
"status",
"scopeType",
"scopeID"
],
"properties": {
"id": {
"description": "Issuance id",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"status": {
"description": "Provisioning status of the issuance.\n`REQUESTED` represents a requested but not yet issued card.\n`PROCESSING` represents a provisioning issuance.\n`ISSUED` represents a provisioned issuance.\n`FAILED` represents an issuance that failed to provision.\n`CLOSED` represents an issuance that has gone through checkout and can no longer be modified.",
"type": "string",
"enum": [
"REQUESTED",
"PROCESSING",
"ISSUED",
"FAILED",
"CLOSED"
],
"example": "ISSUED"
},
"scopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"scopeID": {
"description": "Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"buyerID": {
"description": "Buyer ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"programID": {
"description": "Program ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"tenantID": {
"description": "Tenant ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"paymentProductID": {
"description": "Payment Product ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"applicationSettings": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"applicationID"
],
"properties": {
"applicationID": {
"description": "ID of the application associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantID": {
"description": "ID of the merchant associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantLocationID": {
"description": "ID of the merchant location associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"offerID": {
"description": "ID of the offer associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"posCheckoutCapability": {
"type": "array",
"description": "Array of checkout options that are available at point of sale",
"items": {
"type": "string",
"enum": [
"TapToPay",
"KeyEntry"
]
},
"example": [
"TapToPay",
"KeyEntry"
]
}
},
"example": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"example": {
"id": "b55438f7-c616-45da-ba46-a9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"card": {
"description": "Card information",
"type": "object",
"required": [
"cardID",
"status"
],
"properties": {
"cardToken": {
"description": "Card token.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"lastFour": {
"description": "Last 4 digits of the card number. Added once card is provisioned.",
"type": "string",
"example": "1234"
},
"status": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
},
"expiry": {
"description": "Expiration datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"issuanceDate": {
"description": "Issuance datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-01T21:23:27Z"
},
"pan": {
"description": "Card PAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"cvv": {
"description": "Card CVV. Only available with r:vc.restricted scope.",
"type": "string",
"example": "123"
},
"capacity": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"card_type": {
"description": "SINGLE_USE or MULTI_USE",
"type": "string",
"enum": [
"SINGLE_USE",
"MULTI_USE"
],
"example": "SINGLE_USE"
}
},
"example": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
},
"card_type": "SINGLE_USE"
}
},
"wallets": {
"description": "Wallets associated with the virtual card.",
"type": "array",
"items": {
"description": "Wallet information",
"type": "object",
"required": [
"id",
"type",
"status",
"usedAtCheckout",
"error"
],
"properties": {
"id": {
"description": "Wallet id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"type": {
"description": "Type of wallet.",
"type": "string",
"enum": [
"APPLEPAY",
"GOOGLEPAY"
],
"example": "GOOGLEPAY"
},
"status": {
"description": "Provisioning status of a digital wallet token.\n`PROVISIONING` represents a digital wallet token in the process of provisioning.\n`ACTIVE` represents a successfully provisioned digital wallet token.\n`FAILED` represents a digital wallet token that failed provisioning.\n`SUSPENDED` represents a suspended digital wallet token. Can be reinstated.\n`TERMINATED` represents a terminated digital wallet token. Cannot be reinstated.",
"type": "string",
"enum": [
"PROVISIONING",
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED"
],
"example": "ACTIVE"
},
"dpan": {
"description": "Wallet DPAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"usedAtCheckout": {
"description": "True if this wallet was used for checkout.",
"type": "boolean",
"example": true
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
},
"applePay": {
"description": "ApplePay wallet information",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "Unique state associated with the wallet.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
},
"example": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
},
"googlePay": {
"description": "GooglePay wallet information",
"type": "object",
"required": [
"publicWalletId",
"publicDeviceId"
],
"properties": {
"publicWalletId": {
"description": "GooglePay public wallet id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
},
"publicDeviceId": {
"description": "GooglePay public device id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"example": {
"publicWalletId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd",
"publicDeviceId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
}
},
"example": {
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"dpan": "1234567812345678",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
}
},
"summary": {
"description": "Total authorized/settled/refunded transactions.",
"type": "object",
"required": [
"authorized",
"settled",
"refunded"
],
"properties": {
"authorized": {
"description": "Total authorized transaction.",
"type": "number",
"example": 123.45
},
"settled": {
"description": "Total settled transaction.",
"type": "number",
"example": 123.45
},
"refunded": {
"description": "Total refunded transaction.",
"type": "number",
"example": 123.45
}
},
"example": {
"authorized": 123.45,
"settled": 123.45,
"refunded": 123.45
}
},
"transactions": {
"description": "List of transactions in descending order from when they were received",
"type": "array",
"items": {
"description": "Transaction type and token",
"type": "object",
"required": [
"type",
"token",
"status",
"date"
],
"properties": {
"type": {
"description": "Transaction type.",
"type": "string",
"example": "AUTHORIZATION",
"enum": [
"AUTHORIZATION",
"AUTHORIZATION_CLEARING",
"REFUND",
"AUTHORIZATION_REVERSAL",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
]
},
"token": {
"description": "Transaction token.",
"type": "string",
"example": "12345adsv9n2"
},
"status": {
"description": "Transaction status.",
"type": "string",
"example": "PENDING"
},
"date": {
"description": "Transaction date.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"walletID": {
"description": "Digital wallet token ID used at checkout. If empty, a wallet was not used at checkout.",
"type": "string",
"format": "string",
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
},
"example": {
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z",
"walletID": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
}
}
},
"example": {
"issuance": {
"id": "b55438f7-c616-45da-ba46-b9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
},
"card": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
}
},
"wallets": [
{
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
],
"summary": {
"authorized": 0,
"settled": 0,
"refunded": 0
},
"transactions": [
{
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z"
},
{
"type": "AUTHORIZATION_CLEARING",
"token": "183hgn2948ng294pn5g",
"status": "COMPLETION",
"date": "2022-06-08T21:23:27Z"
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/wallet/{walletId}": {
"get": {
"tags": [
"Virtual Card"
],
"summary": "Get wallet",
"description": "Retrieve info for the specified wallet.",
"operationId": "getWallet",
"security": [
{
"bearerAuthVirtualCard": [
"r:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
{
"description": "Wallet ID",
"name": "walletId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
],
"responses": {
"200": {
"description": "The wallet associated with walletId.",
"content": {
"application/json": {
"schema": {
"description": "Wallet information",
"type": "object",
"required": [
"id",
"type",
"status",
"usedAtCheckout",
"error"
],
"properties": {
"id": {
"description": "Wallet id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"type": {
"description": "Type of wallet.",
"type": "string",
"enum": [
"APPLEPAY",
"GOOGLEPAY"
],
"example": "GOOGLEPAY"
},
"status": {
"description": "Provisioning status of a digital wallet token.\n`PROVISIONING` represents a digital wallet token in the process of provisioning.\n`ACTIVE` represents a successfully provisioned digital wallet token.\n`FAILED` represents a digital wallet token that failed provisioning.\n`SUSPENDED` represents a suspended digital wallet token. Can be reinstated.\n`TERMINATED` represents a terminated digital wallet token. Cannot be reinstated.",
"type": "string",
"enum": [
"PROVISIONING",
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED"
],
"example": "ACTIVE"
},
"dpan": {
"description": "Wallet DPAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"usedAtCheckout": {
"description": "True if this wallet was used for checkout.",
"type": "boolean",
"example": true
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
},
"applePay": {
"description": "ApplePay wallet information",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "Unique state associated with the wallet.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
},
"example": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
},
"googlePay": {
"description": "GooglePay wallet information",
"type": "object",
"required": [
"publicWalletId",
"publicDeviceId"
],
"properties": {
"publicWalletId": {
"description": "GooglePay public wallet id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
},
"publicDeviceId": {
"description": "GooglePay public device id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"example": {
"publicWalletId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd",
"publicDeviceId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
}
},
"example": {
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"dpan": "1234567812345678",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/wallet/{walletId}/pan": {
"get": {
"tags": [
"Virtual Card"
],
"summary": "Get wallet and DPAN",
"description": "Retrieve info for the specified wallet with DPAN.",
"operationId": "getWalletPan",
"security": [
{
"bearerAuthVirtualCard": [
"r:vc.restricted"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
{
"description": "Wallet ID",
"name": "walletId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
],
"responses": {
"200": {
"description": "The wallet and DPAN associated with walletId.",
"content": {
"application/json": {
"schema": {
"description": "Wallet information",
"type": "object",
"required": [
"id",
"type",
"status",
"usedAtCheckout",
"error"
],
"properties": {
"id": {
"description": "Wallet id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"type": {
"description": "Type of wallet.",
"type": "string",
"enum": [
"APPLEPAY",
"GOOGLEPAY"
],
"example": "GOOGLEPAY"
},
"status": {
"description": "Provisioning status of a digital wallet token.\n`PROVISIONING` represents a digital wallet token in the process of provisioning.\n`ACTIVE` represents a successfully provisioned digital wallet token.\n`FAILED` represents a digital wallet token that failed provisioning.\n`SUSPENDED` represents a suspended digital wallet token. Can be reinstated.\n`TERMINATED` represents a terminated digital wallet token. Cannot be reinstated.",
"type": "string",
"enum": [
"PROVISIONING",
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED"
],
"example": "ACTIVE"
},
"dpan": {
"description": "Wallet DPAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"usedAtCheckout": {
"description": "True if this wallet was used for checkout.",
"type": "boolean",
"example": true
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
},
"applePay": {
"description": "ApplePay wallet information",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "Unique state associated with the wallet.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
},
"example": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
},
"googlePay": {
"description": "GooglePay wallet information",
"type": "object",
"required": [
"publicWalletId",
"publicDeviceId"
],
"properties": {
"publicWalletId": {
"description": "GooglePay public wallet id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
},
"publicDeviceId": {
"description": "GooglePay public device id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"example": {
"publicWalletId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd",
"publicDeviceId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
}
},
"example": {
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"dpan": "1234567812345678",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/card/status": {
"post": {
"tags": [
"Virtual Card"
],
"summary": "Update Issuance Status",
"description": "Updating Issuance Card Status",
"operationId": "updateStatus",
"security": [
{
"bearerAuthVirtualCard": [
"u:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"description": "Update issuance status request",
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"SUSPENDED",
"TERMINATED"
],
"description": "String that identifies which status to update to"
}
}
}
}
},
"description": "Update issuance status request",
"required": true
},
"responses": {
"200": {
"description": "200 OK Response confirming status was updated",
"content": {
"application/json": {
"schema": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
}
}
}
},
"400": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/events": {
"get": {
"tags": [
"Virtual Card"
],
"summary": "Get Virtual Card Events",
"description": "Retrieve a list of virtual card events for a given lookup key",
"operationId": "getNotifications",
"security": [
{
"bearerAuthVirtualCard": [
"r:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
],
"responses": {
"200": {
"description": "200 OK Response confirming status was updated",
"content": {
"application/json": {
"schema": {
"description": "List of events that have occurred on the card",
"type": "object",
"required": [
"events"
],
"properties": {
"events": {
"type": "array",
"items": {
"description": "Transaction event that has occurred for the specific card",
"type": "object",
"required": [
"type",
"createdAt",
"cardID"
],
"properties": {
"type": {
"description": "Event type",
"type": "string",
"example": "transactions.authorization"
},
"createdAt": {
"description": "Event date",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"walletID": {
"description": "Digital wallet token ID used at checkout. If empty, a wallet was not used at checkout.",
"type": "string",
"format": "string",
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
}
},
"example": {
"type": "transactions.authorization",
"createdAt": "2022-06-08T21:23:27Z",
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"walletID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"error": false
}
}
}
}
}
}
}
},
"400": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
},
"/api/virtual-card/issuance/{lookupKey}/transaction_data": {
"get": {
"tags": [
"Virtual Card"
],
"summary": "Get Virtual Card Transaction Data",
"description": "Retrieve a list of virtual card transaction data for a given lookup key",
"operationId": "getTransactionData",
"security": [
{
"bearerAuthVirtualCard": [
"r:vc.issuance"
]
}
],
"parameters": [
{
"description": "Issuance lookup key. Either `issuanceID` or '`scopeType`.`scopeID`'",
"name": "lookupKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "APPLICATION.d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
{
"description": "Types of transaction data to include",
"name": "include",
"in": "query",
"required": true,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"AUTHORIZATION",
"REVERSAL",
"SETTLEMENT",
"REFUND",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
]
}
},
"example": [
"AUTHORIZATION",
"SETTLEMENT"
]
},
{
"description": "Include declined transactions",
"name": "includeDeclinedTransactions",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"example": true
}
],
"responses": {
"200": {
"description": "200 OK Response confirming status was updated",
"content": {
"application/json": {
"schema": {
"description": "List of transaction data that has occurred on the card",
"type": "object",
"required": [
"transactions"
],
"properties": {
"transactions": {
"type": "array",
"items": {
"description": "Card Acceptor data from the transaction",
"type": "object",
"required": [
"transaction_id",
"amount",
"date"
],
"properties": {
"id": {
"description": "Event ID",
"type": "string"
},
"transaction_id": {
"description": "Bread transaction_id",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"amount": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"date": {
"description": "Event date",
"type": "string",
"format": "date",
"example": "2022-07-21"
},
"city": {
"description": "City the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "Minneapolis"
},
"state": {
"description": "State the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "MN"
},
"postal_code": {
"description": "Postal code the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "55401"
},
"name": {
"description": "Name of the merchant. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "55401"
},
"type": {
"description": "Type of transaction",
"type": "string",
"enum": [
"AUTHORIZATION",
"REVERSAL",
"SETTLEMENT",
"REFUND",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
],
"example": "AUTHORIZATION"
},
"running_total": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
},
"example": {
"transaction_id": "d8a265ce-5d9c-4d0b-9edd-401450f78e09",
"amount": {
"currency": "USD",
"value": 12345
},
"date": "2022-07-21",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55401",
"name": "Some Merchant",
"type": "AUTHORIZATION",
"running_total": {
"currency": "USD",
"value": 12345
}
}
}
}
}
}
}
}
},
"400": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
},
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"500": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
}
}
}
}
},
"tags": [],
"components": {
"schemas": {
"Extension": {
"type": "object",
"title": "Extension",
"description": "An array of optional key-value pairs.",
"properties": {
"key": {
"type": "string",
"description": "The name of key.",
"example": "locationID"
},
"value": {
"type": "string",
"description": "The value corresponding to the key.",
"example": "1234"
}
}
},
"Disclosure": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
},
"OrderItem": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
},
"Order": {
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
},
"Application": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
},
"ApplicationError": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"ShortCode": {
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
},
"ClientInfo": {
"title": "ClientInfo",
"type": "array",
"description": "Generic client information for use in backend services",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Key under which information can be retrieved for the integrated backend vendor"
},
"value": {
"type": "string",
"description": "Client information for the associated key."
}
}
}
},
"Metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"Offer": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
},
"Status": {
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
},
"ServiceType": {
"title": "ServiceType",
"type": "string",
"enum": [
"MATERIALS",
"SERVICE",
"BOTH"
]
},
"OfferPaymentAgreement": {
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
},
"TxnAuth": {
"type": "object",
"title": "TxnAuth",
"description": "The Transaction Authorization for a given Application, if any.",
"required": [
"id",
"applicationID",
"transactionID",
"authStatus",
"marqetaRTDOutcome",
"transactionAmount",
"remainingCapacity",
"errorMessage",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Transaction Authorization."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Transaction."
},
"fraudResponseID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Fraud Response."
},
"decisionResponseID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Decision Response."
},
"vcCorrelationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the VC Correlation."
},
"authStatus": {
"type": "string",
"description": "The status of the Transaction Authorization.",
"enum": [
"APPROVED",
"DENIED"
]
},
"responseStatus": {
"type": "string",
"description": "The status of the Subsystem Transaction Authorization check.",
"enum": [
"APPROVED",
"DENIED",
"FRAUD_PASS",
"FRAUD_FAIL"
]
},
"responseSubStatus": {
"type": "string",
"description": "The sub-status of the Subsystem Transaction Authorization check.",
"enum": [
"TRANSACTION_AUTH_UNKNOWN_SUBSTATUS",
"TRANSACTION_AUTH_DENIED_LOAN_CURRENTLY_OVERDUE",
"UNKNOWN",
"MARQETA_DENIAL",
"BUYER_STATUS_DENIAL"
]
},
"responseStatusCode": {
"type": "string",
"description": "A six digit string that represents the system, status and substatus of the Subsystem Transaction Authorization check",
"example": "100101"
},
"marqetaRTDOutcome": {
"type": "string",
"description": "Marqeta Real-time decisioning Outcome."
},
"transactionAmount": {
"description": "Transaction amount on the HyLOC",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"remainingCapacity": {
"description": "Remaining capacity on the HyLOC",
"type": "integer",
"example": 40000
},
"errorMessage": {
"description": "The error message of the Transaction Authorization, if any.",
"format": "string"
},
"createdAt": {
"description": "The date-time in UTC this Transaction Authorization was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
},
"VirtualCardError": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
},
"IssuanceResponse": {
"description": "Information on the current issuance.",
"type": "object",
"required": [
"issuance"
],
"properties": {
"issuance": {
"description": "Issuance data",
"type": "object",
"required": [
"id",
"status",
"scopeType",
"scopeID"
],
"properties": {
"id": {
"description": "Issuance id",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"status": {
"description": "Provisioning status of the issuance.\n`REQUESTED` represents a requested but not yet issued card.\n`PROCESSING` represents a provisioning issuance.\n`ISSUED` represents a provisioned issuance.\n`FAILED` represents an issuance that failed to provision.\n`CLOSED` represents an issuance that has gone through checkout and can no longer be modified.",
"type": "string",
"enum": [
"REQUESTED",
"PROCESSING",
"ISSUED",
"FAILED",
"CLOSED"
],
"example": "ISSUED"
},
"scopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"scopeID": {
"description": "Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"buyerID": {
"description": "Buyer ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"programID": {
"description": "Program ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"tenantID": {
"description": "Tenant ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"paymentProductID": {
"description": "Payment Product ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"applicationSettings": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"applicationID"
],
"properties": {
"applicationID": {
"description": "ID of the application associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantID": {
"description": "ID of the merchant associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantLocationID": {
"description": "ID of the merchant location associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"offerID": {
"description": "ID of the offer associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"posCheckoutCapability": {
"type": "array",
"description": "Array of checkout options that are available at point of sale",
"items": {
"type": "string",
"enum": [
"TapToPay",
"KeyEntry"
]
},
"example": [
"TapToPay",
"KeyEntry"
]
}
},
"example": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"example": {
"id": "b55438f7-c616-45da-ba46-a9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"card": {
"description": "Card information",
"type": "object",
"required": [
"cardID",
"status"
],
"properties": {
"cardToken": {
"description": "Card token.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"lastFour": {
"description": "Last 4 digits of the card number. Added once card is provisioned.",
"type": "string",
"example": "1234"
},
"status": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
},
"expiry": {
"description": "Expiration datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"issuanceDate": {
"description": "Issuance datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-01T21:23:27Z"
},
"pan": {
"description": "Card PAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"cvv": {
"description": "Card CVV. Only available with r:vc.restricted scope.",
"type": "string",
"example": "123"
},
"capacity": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"card_type": {
"description": "SINGLE_USE or MULTI_USE",
"type": "string",
"enum": [
"SINGLE_USE",
"MULTI_USE"
],
"example": "SINGLE_USE"
}
},
"example": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
},
"card_type": "SINGLE_USE"
}
},
"wallets": {
"description": "Wallets associated with the virtual card.",
"type": "array",
"items": {
"description": "Wallet information",
"type": "object",
"required": [
"id",
"type",
"status",
"usedAtCheckout",
"error"
],
"properties": {
"id": {
"description": "Wallet id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"type": {
"description": "Type of wallet.",
"type": "string",
"enum": [
"APPLEPAY",
"GOOGLEPAY"
],
"example": "GOOGLEPAY"
},
"status": {
"description": "Provisioning status of a digital wallet token.\n`PROVISIONING` represents a digital wallet token in the process of provisioning.\n`ACTIVE` represents a successfully provisioned digital wallet token.\n`FAILED` represents a digital wallet token that failed provisioning.\n`SUSPENDED` represents a suspended digital wallet token. Can be reinstated.\n`TERMINATED` represents a terminated digital wallet token. Cannot be reinstated.",
"type": "string",
"enum": [
"PROVISIONING",
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED"
],
"example": "ACTIVE"
},
"dpan": {
"description": "Wallet DPAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"usedAtCheckout": {
"description": "True if this wallet was used for checkout.",
"type": "boolean",
"example": true
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
},
"applePay": {
"description": "ApplePay wallet information",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "Unique state associated with the wallet.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
},
"example": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
},
"googlePay": {
"description": "GooglePay wallet information",
"type": "object",
"required": [
"publicWalletId",
"publicDeviceId"
],
"properties": {
"publicWalletId": {
"description": "GooglePay public wallet id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
},
"publicDeviceId": {
"description": "GooglePay public device id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"example": {
"publicWalletId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd",
"publicDeviceId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
}
},
"example": {
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"dpan": "1234567812345678",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
}
},
"summary": {
"description": "Total authorized/settled/refunded transactions.",
"type": "object",
"required": [
"authorized",
"settled",
"refunded"
],
"properties": {
"authorized": {
"description": "Total authorized transaction.",
"type": "number",
"example": 123.45
},
"settled": {
"description": "Total settled transaction.",
"type": "number",
"example": 123.45
},
"refunded": {
"description": "Total refunded transaction.",
"type": "number",
"example": 123.45
}
},
"example": {
"authorized": 123.45,
"settled": 123.45,
"refunded": 123.45
}
},
"transactions": {
"description": "List of transactions in descending order from when they were received",
"type": "array",
"items": {
"description": "Transaction type and token",
"type": "object",
"required": [
"type",
"token",
"status",
"date"
],
"properties": {
"type": {
"description": "Transaction type.",
"type": "string",
"example": "AUTHORIZATION",
"enum": [
"AUTHORIZATION",
"AUTHORIZATION_CLEARING",
"REFUND",
"AUTHORIZATION_REVERSAL",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
]
},
"token": {
"description": "Transaction token.",
"type": "string",
"example": "12345adsv9n2"
},
"status": {
"description": "Transaction status.",
"type": "string",
"example": "PENDING"
},
"date": {
"description": "Transaction date.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"walletID": {
"description": "Digital wallet token ID used at checkout. If empty, a wallet was not used at checkout.",
"type": "string",
"format": "string",
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
},
"example": {
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z",
"walletID": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
}
}
},
"example": {
"issuance": {
"id": "b55438f7-c616-45da-ba46-b9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
},
"card": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
}
},
"wallets": [
{
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
],
"summary": {
"authorized": 0,
"settled": 0,
"refunded": 0
},
"transactions": [
{
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z"
},
{
"type": "AUTHORIZATION_CLEARING",
"token": "183hgn2948ng294pn5g",
"status": "COMPLETION",
"date": "2022-06-08T21:23:27Z"
}
]
}
},
"Issuance": {
"description": "Issuance data",
"type": "object",
"required": [
"id",
"status",
"scopeType",
"scopeID"
],
"properties": {
"id": {
"description": "Issuance id",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"status": {
"description": "Provisioning status of the issuance.\n`REQUESTED` represents a requested but not yet issued card.\n`PROCESSING` represents a provisioning issuance.\n`ISSUED` represents a provisioned issuance.\n`FAILED` represents an issuance that failed to provision.\n`CLOSED` represents an issuance that has gone through checkout and can no longer be modified.",
"type": "string",
"enum": [
"REQUESTED",
"PROCESSING",
"ISSUED",
"FAILED",
"CLOSED"
],
"example": "ISSUED"
},
"scopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"scopeID": {
"description": "Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"buyerID": {
"description": "Buyer ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"programID": {
"description": "Program ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"tenantID": {
"description": "Tenant ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"paymentProductID": {
"description": "Payment Product ID for the issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"applicationSettings": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"applicationID"
],
"properties": {
"applicationID": {
"description": "ID of the application associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantID": {
"description": "ID of the merchant associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantLocationID": {
"description": "ID of the merchant location associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"offerID": {
"description": "ID of the offer associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"posCheckoutCapability": {
"type": "array",
"description": "Array of checkout options that are available at point of sale",
"items": {
"type": "string",
"enum": [
"TapToPay",
"KeyEntry"
]
},
"example": [
"TapToPay",
"KeyEntry"
]
}
},
"example": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"example": {
"id": "b55438f7-c616-45da-ba46-a9798e44d12e",
"status": "ISSUED",
"scopeType": "APPLICATION",
"scopeID": "416d8d11-09f1-49a5-bc58-7c6ec908607d",
"buyerID": "e9ecc348-017d-4091-ae43-09d30065ed57",
"programID": "d6b538c2-88b6-4644-ae4c-62a52f3798cf",
"paymentProductID": "2dd9a835-48e1-4b7f-a15d-fa5e47eca0a4",
"tenantID": "b7e4f68d-983b-4d1d-b114-9e0d87eedd0b",
"applicationSettings": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
}
},
"Card": {
"description": "Card information",
"type": "object",
"required": [
"cardID",
"status"
],
"properties": {
"cardToken": {
"description": "Card token.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"lastFour": {
"description": "Last 4 digits of the card number. Added once card is provisioned.",
"type": "string",
"example": "1234"
},
"status": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
},
"expiry": {
"description": "Expiration datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"issuanceDate": {
"description": "Issuance datetime. Added once card is provisioned.",
"type": "string",
"format": "date-time",
"example": "2022-06-01T21:23:27Z"
},
"pan": {
"description": "Card PAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"cvv": {
"description": "Card CVV. Only available with r:vc.restricted scope.",
"type": "string",
"example": "123"
},
"capacity": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"card_type": {
"description": "SINGLE_USE or MULTI_USE",
"type": "string",
"enum": [
"SINGLE_USE",
"MULTI_USE"
],
"example": "SINGLE_USE"
}
},
"example": {
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"lastFour": "0700",
"status": "ACTIVE",
"expiry": "2022-06-08T21:23:27Z",
"issuanceDate": "2022-06-01T21:23:27Z",
"capacity": {
"currency": "USD",
"value": 12345
},
"card_type": "SINGLE_USE"
}
},
"Wallet": {
"description": "Wallet information",
"type": "object",
"required": [
"id",
"type",
"status",
"usedAtCheckout",
"error"
],
"properties": {
"id": {
"description": "Wallet id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"type": {
"description": "Type of wallet.",
"type": "string",
"enum": [
"APPLEPAY",
"GOOGLEPAY"
],
"example": "GOOGLEPAY"
},
"status": {
"description": "Provisioning status of a digital wallet token.\n`PROVISIONING` represents a digital wallet token in the process of provisioning.\n`ACTIVE` represents a successfully provisioned digital wallet token.\n`FAILED` represents a digital wallet token that failed provisioning.\n`SUSPENDED` represents a suspended digital wallet token. Can be reinstated.\n`TERMINATED` represents a terminated digital wallet token. Cannot be reinstated.",
"type": "string",
"enum": [
"PROVISIONING",
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED"
],
"example": "ACTIVE"
},
"dpan": {
"description": "Wallet DPAN. Only available with r:vc.restricted scope.",
"type": "string",
"example": "1234567812345678"
},
"usedAtCheckout": {
"description": "True if this wallet was used for checkout.",
"type": "boolean",
"example": true
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
},
"applePay": {
"description": "ApplePay wallet information",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "Unique state associated with the wallet.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
},
"example": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
},
"googlePay": {
"description": "GooglePay wallet information",
"type": "object",
"required": [
"publicWalletId",
"publicDeviceId"
],
"properties": {
"publicWalletId": {
"description": "GooglePay public wallet id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
},
"publicDeviceId": {
"description": "GooglePay public device id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"example": {
"publicWalletId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd",
"publicDeviceId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
}
},
"example": {
"id": "bc1c000b-5db2-4651-bd6e-4178438e7485",
"type": "APPLEPAY",
"status": "ACTIVE",
"dpan": "1234567812345678",
"usedAtCheckout": true,
"error": false,
"applePay": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
}
},
"Summary": {
"description": "Total authorized/settled/refunded transactions.",
"type": "object",
"required": [
"authorized",
"settled",
"refunded"
],
"properties": {
"authorized": {
"description": "Total authorized transaction.",
"type": "number",
"example": 123.45
},
"settled": {
"description": "Total settled transaction.",
"type": "number",
"example": 123.45
},
"refunded": {
"description": "Total refunded transaction.",
"type": "number",
"example": 123.45
}
},
"example": {
"authorized": 123.45,
"settled": 123.45,
"refunded": 123.45
}
},
"CardTransaction": {
"description": "Transaction type and token",
"type": "object",
"required": [
"type",
"token",
"status",
"date"
],
"properties": {
"type": {
"description": "Transaction type.",
"type": "string",
"example": "AUTHORIZATION",
"enum": [
"AUTHORIZATION",
"AUTHORIZATION_CLEARING",
"REFUND",
"AUTHORIZATION_REVERSAL",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
]
},
"token": {
"description": "Transaction token.",
"type": "string",
"example": "12345adsv9n2"
},
"status": {
"description": "Transaction status.",
"type": "string",
"example": "PENDING"
},
"date": {
"description": "Transaction date.",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"walletID": {
"description": "Digital wallet token ID used at checkout. If empty, a wallet was not used at checkout.",
"type": "string",
"format": "string",
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
},
"example": {
"type": "AUTHORIZATION",
"token": "12345adsv9n2",
"status": "PENDING",
"date": "2022-06-08T21:23:27Z",
"walletID": "970243f5-f23c-4a51-8b9b-b781e549b75f"
}
},
"ApplePay": {
"description": "ApplePay wallet information",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "Unique state associated with the wallet.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
},
"example": {
"state": "421c000b-5db2-4651-bd6e-4178438e7486"
}
},
"GooglePay": {
"description": "GooglePay wallet information",
"type": "object",
"required": [
"publicWalletId",
"publicDeviceId"
],
"properties": {
"publicWalletId": {
"description": "GooglePay public wallet id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
},
"publicDeviceId": {
"description": "GooglePay public device id",
"type": "string",
"example": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"example": {
"publicWalletId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd",
"publicDeviceId": "c28faaa0-e41e-4bf5-8158-5045e5bed8bd"
}
},
"InStoreIssuance": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"applicationID"
],
"properties": {
"applicationID": {
"description": "ID of the application associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantID": {
"description": "ID of the merchant associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"merchantLocationID": {
"description": "ID of the merchant location associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"offerID": {
"description": "ID of the offer associated with this in-store issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"posCheckoutCapability": {
"type": "array",
"description": "Array of checkout options that are available at point of sale",
"items": {
"type": "string",
"enum": [
"TapToPay",
"KeyEntry"
]
},
"example": [
"TapToPay",
"KeyEntry"
]
}
},
"example": {
"applicationID": "ca9b3507-d225-496d-843e-cefcf43d4db8",
"merchantID": "613e035a-4260-4337-9198-f273f295e222",
"merchantLocationID": "86bdc28f-3484-404b-a2ac-f62d0d0a2ec8",
"offerID": "53214430-7cf1-4854-931c-079f38fa6749"
}
},
"IssueVirtualCardRequest": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"scopeID",
"scopeType",
"buyerID",
"programID"
],
"properties": {
"scopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"scopeID": {
"description": "Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"programID": {
"description": "ID of the program associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"buyerID": {
"description": "ID of the buyer associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"applicationSettings": {
"description": "Additional metadata if the scopeType is APPLICATION.",
"type": "object",
"properties": {
"merchantID": {
"description": "ID of the merchant associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "e3b1d6f5-bc6a-4835-b40e-5f1a22dacf6a"
}
},
"example": {
"merchantID": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
}
},
"example": {
"scopeType": "APPLICATION",
"scopeID": "a2b1fa94-98fc-4de3-9b76-7c0de89fcbb1",
"programID": "0efc5a37-96fe-4636-9966-bf3ab26c3f29",
"buyerID": "c1c1fdd1-811c-4ea2-bf37-2af9ea348299",
"applicationSettings": {
"merchantID": "e3b1d6f5-bc6a-4835-b40e-5f1a22dacf6a"
}
}
},
"IssueApplePayRequest": {
"description": "ApplePay issuance request",
"type": "object",
"properties": {},
"example": {}
},
"IssueGooglePayRequest": {
"description": "GooglePay issuance request",
"type": "object",
"required": [
"serverSessionId",
"clientSessionId",
"tokenSetting",
"cardSetting",
"publicWalletId",
"publicDeviceId",
"integratorId"
],
"properties": {
"serverSessionId": {
"type": "string",
"example": "8c84fab9-889c-4cb7-a330-accac5799ea5",
"description": "A string that identifies the backend session. Provided by Google pay backend."
},
"clientSessionId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "A string that identifies the client session. Provided by Google pay backend."
},
"tokenSetting": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "1 => Tokenization will be attempted.; 0 => Tokenization will not be attempted.",
"enum": [
0,
1
]
},
"cardSetting": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "1 => FPAN save will be attempted.; 0 => FPAN save will not be attempted.",
"enum": [
0,
1
]
},
"publicWalletId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "String identifying the device-scoped Google Pay wallet that will receive the token. Provided by Google Pay backend."
},
"publicDeviceId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "String identifying the Android device that will receive the token. Provided by Google Pay backend"
},
"integratorId": {
"type": "string",
"example": "ACMEISSUER_1",
"description": "A Google-assigned string that uniquely identifies both the integrator that is initiating the session and the issuer of the payment card."
}
},
"example": {
"serverSessionId": "8c84fab9-889c-4cb7-a330-accac5799ea5",
"clientSessionId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"tokenSetting": 1,
"cardSetting": 1,
"publicWalletId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"publicDeviceId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"integratorId": "ACMEISSUER_1"
}
},
"UpdateCardStatusRequest": {
"description": "Update issuance status request",
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"SUSPENDED",
"TERMINATED"
],
"description": "String that identifies which status to update to"
}
}
},
"WalletIssuanceResponse": {
"description": "Response from a digital wallet issuance request.",
"type": "object",
"properties": {
"state": {
"description": "Unique state associated with the wallet. Added to payload if ApplePay wallet was provisioned.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"jws": {
"type": "object",
"required": [
"header",
"payload",
"protected",
"signature"
],
"properties": {
"header": {
"type": "object",
"required": [
"kid"
],
"properties": {
"kid": {
"type": "string",
"example": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c",
"description": "The ID for the JWS Public Key of the key pair used to generate signature."
}
}
},
"protected": {
"type": "string",
"example": "Encoding-BASE64URL(UTF8(Value)): {\n \"alg\": \"ES256\",\n \"cty\": \"application/credential;charset=utf-8\",\n \"typ\": \"JOSE+JSON\"\n \"x5t#S256\":\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\"\n}",
"description": "JWS Protected Headers, contains the Header Parameters that are integrity protected by the JWS Signature."
},
"payload": {
"type": "string",
"example": "Encoding-BASE64URL(Value): {\n \"jti\": \"491e392a-b03b-422d-900b-7f8e268f9718\",\n \"lid\": \"en-US\",\n \"iss\": \"ORG-ffffffff-abcd-1234-7890-ffffffffffff\",\n \"sub\": \"provisioningTarget\"\n \"aud\": \"Apple\",\n \"exp\": 1640341542706,\n \"iat\": 1640337942706,\n \"cti\": \"5c4e4dea-a841-4614-8990-eb172328317a\",\n}",
"description": "JWS payload which includes the message to be sent."
},
"signature": {
"type": "string",
"example": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w",
"description": "JWS Signature"
}
},
"example": {
"header": {
"kid": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c"
},
"payload": "Encoding-BASE64URL(Value): {\\n \\\"jti\\\": \\\"491e392a-b03b-422d-900b-7f8e268f9718\\\",\\n \\\"lid\\\": \\\"en-US\\\",\\n \\\"iss\\\": \\\"ORG-ffffffff-abcd-1234-7890-ffffffffffff\\\",\\n \\\"sub\\\": \\\"provisioningTarget\\\"\\n \\\"aud\\\": \\\"Apple\\\",\\n \\\"exp\\\": 1640341542706,\\n \\\"iat\\\": 1640337942706,\\n \\\"cti\\\": \\\"5c4e4dea-a841-4614-8990-eb172328317a\\\",\\n}",
"protected": "Encoding-BASE64URL(UTF8(Value)): {\\n \\\"alg\\\": \\\"ES256\\\",\\n \\\"cty\\\": \\\"application/credential;charset=utf-8\\\",\\n \\\"typ\\\": \\\"JOSE+JSON\\\"\\n \\\"x5t#S256\\\":\\\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\\\"\\n}",
"signature": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w"
}
}
},
"example": {
"state": "d8a265ce-5d9c-4d0b-9edd-401450f78e09",
"jws": {
"header": {
"kid": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c"
},
"payload": "Encoding-BASE64URL(Value): {\\n \\\"jti\\\": \\\"491e392a-b03b-422d-900b-7f8e268f9718\\\",\\n \\\"lid\\\": \\\"en-US\\\",\\n \\\"iss\\\": \\\"ORG-ffffffff-abcd-1234-7890-ffffffffffff\\\",\\n \\\"sub\\\": \\\"provisioningTarget\\\"\\n \\\"aud\\\": \\\"Apple\\\",\\n \\\"exp\\\": 1640341542706,\\n \\\"iat\\\": 1640337942706,\\n \\\"cti\\\": \\\"5c4e4dea-a841-4614-8990-eb172328317a\\\",\\n}",
"protected": "Encoding-BASE64URL(UTF8(Value)): {\\n \\\"alg\\\": \\\"ES256\\\",\\n \\\"cty\\\": \\\"application/credential;charset=utf-8\\\",\\n \\\"typ\\\": \\\"JOSE+JSON\\\"\\n \\\"x5t#S256\\\":\\\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\\\"\\n}",
"signature": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w"
}
}
},
"ScopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"IssuanceStatus": {
"description": "Provisioning status of the issuance.\n`REQUESTED` represents a requested but not yet issued card.\n`PROCESSING` represents a provisioning issuance.\n`ISSUED` represents a provisioned issuance.\n`FAILED` represents an issuance that failed to provision.\n`CLOSED` represents an issuance that has gone through checkout and can no longer be modified.",
"type": "string",
"enum": [
"REQUESTED",
"PROCESSING",
"ISSUED",
"FAILED",
"CLOSED"
],
"example": "ISSUED"
},
"CardStatus": {
"description": "Provisioning status of a virtual card.\n`ACTIVE` represents a provisioned card.\n`FAILED` represents a card that failed provisioning.\n`SUSPENDED` represents a suspended card. Can be reinstated.\n`TERMINATED` represents a terminated card. Cannot be reinstated. \n`NOT_CREATED` represents initial state of the card which has not been created in the vendor yet.",
"type": "string",
"enum": [
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED",
"NOT_CREATED"
],
"example": "ACTIVE"
},
"WalletStatus": {
"description": "Provisioning status of a digital wallet token.\n`PROVISIONING` represents a digital wallet token in the process of provisioning.\n`ACTIVE` represents a successfully provisioned digital wallet token.\n`FAILED` represents a digital wallet token that failed provisioning.\n`SUSPENDED` represents a suspended digital wallet token. Can be reinstated.\n`TERMINATED` represents a terminated digital wallet token. Cannot be reinstated.",
"type": "string",
"enum": [
"PROVISIONING",
"ACTIVE",
"FAILED",
"SUSPENDED",
"TERMINATED"
],
"example": "ACTIVE"
},
"WalletType": {
"description": "Type of wallet.",
"type": "string",
"enum": [
"APPLEPAY",
"GOOGLEPAY"
],
"example": "GOOGLEPAY"
},
"ApplePayJws": {
"type": "object",
"required": [
"header",
"payload",
"protected",
"signature"
],
"properties": {
"header": {
"type": "object",
"required": [
"kid"
],
"properties": {
"kid": {
"type": "string",
"example": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c",
"description": "The ID for the JWS Public Key of the key pair used to generate signature."
}
}
},
"protected": {
"type": "string",
"example": "Encoding-BASE64URL(UTF8(Value)): {\n \"alg\": \"ES256\",\n \"cty\": \"application/credential;charset=utf-8\",\n \"typ\": \"JOSE+JSON\"\n \"x5t#S256\":\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\"\n}",
"description": "JWS Protected Headers, contains the Header Parameters that are integrity protected by the JWS Signature."
},
"payload": {
"type": "string",
"example": "Encoding-BASE64URL(Value): {\n \"jti\": \"491e392a-b03b-422d-900b-7f8e268f9718\",\n \"lid\": \"en-US\",\n \"iss\": \"ORG-ffffffff-abcd-1234-7890-ffffffffffff\",\n \"sub\": \"provisioningTarget\"\n \"aud\": \"Apple\",\n \"exp\": 1640341542706,\n \"iat\": 1640337942706,\n \"cti\": \"5c4e4dea-a841-4614-8990-eb172328317a\",\n}",
"description": "JWS payload which includes the message to be sent."
},
"signature": {
"type": "string",
"example": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w",
"description": "JWS Signature"
}
},
"example": {
"header": {
"kid": "8dc7aed4-29e3-41e4-9cdb-673a05e6615c"
},
"payload": "Encoding-BASE64URL(Value): {\\n \\\"jti\\\": \\\"491e392a-b03b-422d-900b-7f8e268f9718\\\",\\n \\\"lid\\\": \\\"en-US\\\",\\n \\\"iss\\\": \\\"ORG-ffffffff-abcd-1234-7890-ffffffffffff\\\",\\n \\\"sub\\\": \\\"provisioningTarget\\\"\\n \\\"aud\\\": \\\"Apple\\\",\\n \\\"exp\\\": 1640341542706,\\n \\\"iat\\\": 1640337942706,\\n \\\"cti\\\": \\\"5c4e4dea-a841-4614-8990-eb172328317a\\\",\\n}",
"protected": "Encoding-BASE64URL(UTF8(Value)): {\\n \\\"alg\\\": \\\"ES256\\\",\\n \\\"cty\\\": \\\"application/credential;charset=utf-8\\\",\\n \\\"typ\\\": \\\"JOSE+JSON\\\"\\n \\\"x5t#S256\\\":\\\"2CF24DBA5FB0A30E26E83B2AC5B9E29E1B161E5C1FA7425E73043362938B9824\\\"\\n}",
"signature": "5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w"
}
},
"CardEvents": {
"description": "List of events that have occurred on the card",
"type": "object",
"required": [
"events"
],
"properties": {
"events": {
"type": "array",
"items": {
"description": "Transaction event that has occurred for the specific card",
"type": "object",
"required": [
"type",
"createdAt",
"cardID"
],
"properties": {
"type": {
"description": "Event type",
"type": "string",
"example": "transactions.authorization"
},
"createdAt": {
"description": "Event date",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"walletID": {
"description": "Digital wallet token ID used at checkout. If empty, a wallet was not used at checkout.",
"type": "string",
"format": "string",
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
}
},
"example": {
"type": "transactions.authorization",
"createdAt": "2022-06-08T21:23:27Z",
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"walletID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"error": false
}
}
}
}
},
"CardEvent": {
"description": "Transaction event that has occurred for the specific card",
"type": "object",
"required": [
"type",
"createdAt",
"cardID"
],
"properties": {
"type": {
"description": "Event type",
"type": "string",
"example": "transactions.authorization"
},
"createdAt": {
"description": "Event date",
"type": "string",
"format": "date-time",
"example": "2022-06-08T21:23:27Z"
},
"cardID": {
"description": "Card id.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"walletID": {
"description": "Digital wallet token ID used at checkout. If empty, a wallet was not used at checkout.",
"type": "string",
"format": "string",
"example": "970243f5-f23c-4a51-8b9b-b781e549b75f"
},
"error": {
"description": "True if this wallet has an error state.",
"type": "boolean",
"example": true
}
},
"example": {
"type": "transactions.authorization",
"createdAt": "2022-06-08T21:23:27Z",
"cardID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"walletID": "970243f5-f23c-4a51-8b9b-b781e549b75f",
"error": false
}
},
"TransactionDataList": {
"description": "List of transaction data that has occurred on the card",
"type": "object",
"required": [
"transactions"
],
"properties": {
"transactions": {
"type": "array",
"items": {
"description": "Card Acceptor data from the transaction",
"type": "object",
"required": [
"transaction_id",
"amount",
"date"
],
"properties": {
"id": {
"description": "Event ID",
"type": "string"
},
"transaction_id": {
"description": "Bread transaction_id",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"amount": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"date": {
"description": "Event date",
"type": "string",
"format": "date",
"example": "2022-07-21"
},
"city": {
"description": "City the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "Minneapolis"
},
"state": {
"description": "State the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "MN"
},
"postal_code": {
"description": "Postal code the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "55401"
},
"name": {
"description": "Name of the merchant. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "55401"
},
"type": {
"description": "Type of transaction",
"type": "string",
"enum": [
"AUTHORIZATION",
"REVERSAL",
"SETTLEMENT",
"REFUND",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
],
"example": "AUTHORIZATION"
},
"running_total": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
},
"example": {
"transaction_id": "d8a265ce-5d9c-4d0b-9edd-401450f78e09",
"amount": {
"currency": "USD",
"value": 12345
},
"date": "2022-07-21",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55401",
"name": "Some Merchant",
"type": "AUTHORIZATION",
"running_total": {
"currency": "USD",
"value": 12345
}
}
}
}
}
},
"TransactionData": {
"description": "Card Acceptor data from the transaction",
"type": "object",
"required": [
"transaction_id",
"amount",
"date"
],
"properties": {
"id": {
"description": "Event ID",
"type": "string"
},
"transaction_id": {
"description": "Bread transaction_id",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"amount": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"date": {
"description": "Event date",
"type": "string",
"format": "date",
"example": "2022-07-21"
},
"city": {
"description": "City the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "Minneapolis"
},
"state": {
"description": "State the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "MN"
},
"postal_code": {
"description": "Postal code the transaction took place it. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "55401"
},
"name": {
"description": "Name of the merchant. Optional. Best guess based on the card acceptor data.",
"type": "string",
"example": "55401"
},
"type": {
"description": "Type of transaction",
"type": "string",
"enum": [
"AUTHORIZATION",
"REVERSAL",
"SETTLEMENT",
"REFUND",
"CHARGEBACK",
"CHARGEBACK_REVERSAL"
],
"example": "AUTHORIZATION"
},
"running_total": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
},
"example": {
"transaction_id": "d8a265ce-5d9c-4d0b-9edd-401450f78e09",
"amount": {
"currency": "USD",
"value": 12345
},
"date": "2022-07-21",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55401",
"name": "Some Merchant",
"type": "AUTHORIZATION",
"running_total": {
"currency": "USD",
"value": 12345
}
}
},
"CountryCode": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
},
"Region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"CurrencyCode": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"LanguageCode": {
"type": "string",
"description": "The two language code as defined in ISO 639-1 along with subtags tag if applicable.",
"minLength": 2,
"example": "en or en-US",
"externalDocs": {
"description": "ISO 639-1",
"url": "https://en.wikipedia.org/wiki/ISO_639-1"
}
},
"Money": {
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
"Phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"Email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
},
"Percentage": {
"type": "number",
"description": "Percentage value",
"minimum": 0,
"maximum": 100,
"example": 21.5
},
"BasisPoint": {
"type": "integer",
"description": "A value which represents one-hundredth of one percent.",
"minimum": 0,
"example": 500,
"externalDocs": {
"description": "BasisPoint",
"url": "https://www.investopedia.com/terms/b/basispoint.asp"
}
},
"Date": {
"type": "string",
"format": "date",
"description": "The date value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
},
"NullDate": {
"type": "string",
"format": "date",
"nullable": true,
"description": "The date value formatted per RFC3339. This allows nulls.",
"example": "2020-12-31",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
},
"Timestamp": {
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
},
"NullTimestamp": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The timestamp value formatted per RFC3339. This does allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
},
"UUID": {
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
},
"NullUUID": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This allows nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
},
"Address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"Name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"Contact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"BankAccountDetail": {
"type": "object",
"description": "Bank account detail definition",
"required": [
"accountNumber",
"accountType",
"currencyCode",
"identifiers"
],
"properties": {
"name": {
"type": "string",
"description": "User provided name for the account"
},
"accountNumber": {
"type": "string",
"description": "The bank account number"
},
"accountType": {
"type": "string",
"description": "The type of account, checking or savings",
"enum": [
"CHECKING",
"SAVINGS"
]
},
"currencyCode": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"branchLocation": {
"allOf": [
{
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
}
],
"description": "The branch location, if applicable"
},
"identifiers": {
"type": "array",
"description": "A list of identifiers to be used in conjunction with the account number",
"minItems": 1,
"items": {
"type": "object",
"required": [
"identifier",
"value"
],
"properties": {
"identifier": {
"type": "string",
"description": "Bank account identifier",
"enum": [
"ROUTING_NUMBER",
"BANK_CODE",
"BRANCH_CODE"
]
},
"value": {
"type": "string",
"description": "Value of the identifier"
}
},
"example": {
"identifier": "ROUTING_NUMBER",
"value": "021000322"
}
}
}
}
},
"BusinessIdentity": {
"type": "object",
"description": "Identity for a business",
"required": [
"identifier",
"value"
],
"properties": {
"identifier": {
"type": "string",
"enum": [
"EMPLOYER_IDENTIFICATION_NUMBER",
"TAX_IDENTIFICATION_NUMBER"
],
"description": "Identifier for a business"
},
"value": {
"type": "string",
"description": "The value of the identifier"
}
},
"example": {
"identifier": "EMPLOYER_IDENTIFICATION_NUMBER",
"value": "77-1122333"
}
},
"PersonIdentity": {
"type": "object",
"description": "Identity for a person",
"required": [
"identifier",
"value"
],
"properties": {
"type": {
"type": "string",
"enum": [
"SOCIAL_SECURITY_NUMBER",
"TAX_IDENTIFICATION_NUMBER"
],
"description": "Identifier for a person"
},
"value": {
"type": "string",
"description": "The value of the identifier"
}
},
"example": {
"identifier": "SOCIAL_SECURITY_NUMBER",
"value": "111-22-3333"
}
},
"BankIdentifier": {
"type": "object",
"required": [
"identifier",
"value"
],
"properties": {
"identifier": {
"type": "string",
"description": "Bank account identifier",
"enum": [
"ROUTING_NUMBER",
"BANK_CODE",
"BRANCH_CODE"
]
},
"value": {
"type": "string",
"description": "Value of the identifier"
}
},
"example": {
"identifier": "ROUTING_NUMBER",
"value": "021000322"
}
},
"PaymentProductType": {
"type": "string",
"description": "The type of payment product",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
],
"example": "INSTALLMENTS"
},
"TermInterval": {
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
},
"Terms": {
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
},
"AsLowAs": {
"type": "object",
"required": [
"terms",
"paymentAmount",
"minRate",
"maxRate",
"promptText",
"paymentAmountText"
],
"properties": {
"terms": {
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
],
"description": "The terms used to determine the payment"
},
"paymentAmount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The cost of each payment based on the terms"
},
"minRate": {
"type": "number",
"format": "float",
"description": "The minimum interest rate that may be offered",
"example": 2.99
},
"maxRate": {
"type": "number",
"format": "float",
"description": "The maximum interest rate that may be offered",
"example": 29.99
},
"promptText": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The financing disclosure text that can be provided to the buyer in the appropriate language",
"example": {
"en-us": "A sample prompt text in the appropriate locale",
"ca-fr": "Un exemple de texte en français canadien"
}
},
"paymentAmountText": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The payment amount with the appropriate formatting",
"example": {
"en-us": "$150.25",
"ca-fr": "150.25 $"
}
}
},
"description": "Represents a sample offer with the appropriate user prompts for a given amount and apr along with apr bounds"
},
"Identity": {
"type": "object",
"description": "The claims that determines the access level of the caller.",
"properties": {
"tenantID": {
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
],
"description": "An UUID that represents a tenant."
},
"buyerID": {
"allOf": [
{
"type": "string",
"format": "uuid",
"nullable": true,
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This allows nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
],
"description": "An UUID that represents a buyer."
},
"merchantID": {
"allOf": [
{
"type": "string",
"format": "uuid",
"nullable": true,
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This allows nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
],
"description": "An UUID that represents a merchant."
},
"partnerID": {
"allOf": [
{
"type": "string",
"format": "uuid",
"nullable": true,
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This allows nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
],
"description": "An UUID that represents a partner."
},
"programID": {
"allOf": [
{
"type": "string",
"format": "uuid",
"nullable": true,
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This allows nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
],
"description": "An UUID that represents a program."
}
},
"required": [
"tenantID"
]
},
"Error": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"BaseError": {
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
},
"responses": {
"401": {
"description": "Unauthorized. Indicates that provided credentials is not valid",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Jwt is expired"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 401,
"domain": "Auth",
"message": "Invalid authentication",
"reason": "Invalid_Authentication"
}
}
}
},
"403": {
"description": "Forbidden. Indicates that request cannot be authorized",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "RBAC: Access Denied"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 403,
"domain": "Auth",
"message": "RBAC: Access Denied",
"reason": "Access_Denied"
}
}
}
},
"410": {
"description": "Record no longer available",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Gone"
}
},
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
},
"example": {
"code": 410,
"domain": "Cart",
"message": "Gone",
"reason": "Gone"
}
}
}
},
"applicationResponse": {
"description": "The Application as a response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
}
}
},
"listApplicationResponse": {
"description": "The list of Applications including pagination.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applications": {
"description": "The list of Applications that satisfy the provided filtering and scope conditions.",
"type": "array",
"items": {
"type": "object",
"title": "Application",
"description": "The Application for a given Buyer with Payment Agreement(s), if any.",
"required": [
"id",
"buyerID",
"createdAt",
"expiresAt",
"tenantID",
"merchantID",
"paymentAgreements",
"programID",
"offers",
"order",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"buyerID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Buyer."
},
"tenantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Tenant."
},
"merchantID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Merchant."
},
"programID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Program."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "If exists, unique identifier of the payment method for an application."
},
"locationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Location for instore applications."
},
"cartID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Cart for applications associated with a Cart"
},
"billingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"shippingContact": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
},
"order": {
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"allOf": [
{
"type": "object",
"title": "Order",
"description": "The collection of items that the Buyer wants to purchase with a Bread product.",
"required": [
"subTotal",
"totalDiscounts",
"totalPrice",
"totalShipping",
"totalTax"
],
"properties": {
"subTotal": {
"description": "The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalDiscounts": {
"description": "The total price of discounts applied to this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalPrice": {
"description": "The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalShipping": {
"description": "The total shipping costs for this Order. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"totalTax": {
"description": "The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"discountCode": {
"type": "string",
"description": "Discount code applied to this Order."
},
"pickupInformation": {
"description": "Pickup information describes a person and store location for pickup.",
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
}
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY",
"MULTIPLE"
],
"description": "The fulfillment type of the order."
},
"items": {
"type": "array",
"description": "The list of items to be purchased in this Order.",
"items": {
"type": "object",
"title": "Order Item",
"description": "An item that the Buyer wants to purchase with a Bread product.",
"required": [
"name",
"quantity",
"unitPrice",
"unitTax",
"shippingCost"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the item to be purchased.",
"example": "Noise Cancelling Headphones Q30"
},
"category": {
"type": "string",
"description": "The category of the product under which the item is listed.",
"example": "Headphones"
},
"quantity": {
"type": "integer",
"description": "The number of items to be purchased. The value must be greater than 0.",
"example": 2
},
"unitPrice": {
"description": "The price per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"unitTax": {
"description": "The tax per unit of item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"sku": {
"type": "string",
"description": "The unique SKU number of the item."
},
"itemUrl": {
"type": "string",
"description": "The URL for referencing further details about the item."
},
"imageUrl": {
"type": "string",
"description": "The URL for the item image."
},
"description": {
"type": "string",
"description": "A longer description of the item."
},
"shippingCost": {
"description": "The cost of shipping all units of this item. The value must be greater than or equal to 0.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingProvider": {
"type": "string",
"description": "The provider that will be used to ship the item."
},
"shippingDescription": {
"type": "string",
"description": "The description of the shipping method (e.g. standard, express)."
},
"shippingTrackingNumber": {
"type": "string",
"description": "The tracking number that is provided by a shipping provider."
},
"shippingTrackingUrl": {
"type": "string",
"description": "The URL for referencing further details about the shipping."
},
"fulfillmentType": {
"type": "string",
"enum": [
"",
"PICKUP",
"DELIVERY"
],
"description": "The fulfillment type of the order item."
}
}
}
}
}
}
]
},
"paymentAgreements": {
"description": "The list of Payment Agreements associated with the Application.",
"type": "array",
"items": {
"type": "object",
"description": "A Payment Agreement offered to the Buyer for this Application.",
"required": [
"id",
"createdAt",
"updatedAt",
"paymentProductID",
"paymentAmount",
"status",
"terms"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Agreement that was created during Start."
},
"paymentProductID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"status": {
"type": "string",
"enum": [
"OFFERED",
"ACCEPTED",
"EXPIRED",
"REVIEW",
"OUTSTANDING",
"PAID",
"CHARGED_OFF",
"CANCELLED",
"CLOSED"
],
"description": "The Status of the Payment Agreement."
},
"statusCodes": {
"description": "List of numerical status codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The capacity of the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Payment Agreement's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shortCode": {
"description": "The short code of the Payment Agreement, for in-store application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"paymentAmount": {
"description": "The cost of each payment, calculated using the terms.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"terms": {
"description": "The terms of the Payment Agreement.",
"allOf": [
{
"type": "object",
"required": [
"amount",
"interval",
"length",
"rate"
],
"properties": {
"amount": {
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"description": "The total amount for the term"
},
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The payment interval for the term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The interest rate for the term",
"example": 5.75
}
},
"description": "Represents the terms offered for a payment product"
}
]
},
"createdAt": {
"description": "The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"offers": {
"description": "The list of Offers associated with the Application.",
"type": "array",
"items": {
"title": "Offer",
"type": "object",
"description": "The Offer being presented to the Buyer",
"required": [
"id",
"capacity",
"paymentProduct"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer."
},
"paymentMethodID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Method."
},
"paymentProduct": {
"type": "object",
"description": "The Payment Product of the Offer",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Payment Product."
},
"type": {
"type": "string",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT",
"DEFERRED_INTEREST_INSTALLMENTS"
]
}
}
},
"status": {
"description": "The status of the Offer.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"description": "List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**020101** - Buyer is eligible
Experience Code: 000
**020202** - Buyer is ineligible (status)
Experience Code: 008
**020203** - Buyer is ineligible (country)
Experience Code: 008
**020204** - Buyer is ineligible (region)
Experience Code: 008
**020205** - Buyer is ineligible (age)
Experience Code: 008
**020206** - Buyer is ineligible (age - AL)
Experience Code: 002
**020207** - Buyer is ineligible due to invalid PO box address
Experience Code: 003
**020208** - Buyer is ineligible due to address being No Match
Experience Code: 004
**030101** - Application approved for checkout
Experience Code: 000
**030102** - Application partially approved for checkout
Experience Code: 000
**030103** - Application contingent approved for checkout
Experience Code: 012
**030205** - Merchant/payment product configured cart size doesn't fit
Experience Code: 008
**030209** - Ineligible denied in last 90 Days
**030211** - Participating in Skip Payments
Experience Code: 008
**030231** - Max card attempts last 30 days
Experience Code: 008
**030232** - Unpaid outstanding loans
Experience Code: 008
**030240** - Credit pulled 5 or more times within 24 hours
**030306** - Credit Freeze
Experience Code: 005
**030307** - DOB, short SSN mismatch or Credit No Hit
**030353** - Incomplete No EFA Phone Number
Experience Code: 001
**030354** - Incomplete Credit Optics Freeze
Experience Code: 005
**030355** - Incomplete Precise ID Freeze
Experience Code: 005
**030404** - Full SSN mismatch or credit no hit (with full SSN)
Experience Code: 008
**030408** - Credit Denial
**030410** - Credit freeze denial
**030412** - ADS Credit file denial from underwriting service
Experience Code: 008
**030413** - ADS Credit file denial from underwriting service
Experience Code: 008
**030414** - ADS Credit file denial from underwriting service
Experience Code: 008
**030415** - ADS Credit file denial from underwriting service
**030416** - ADS Credit file denial from underwriting service
**030417** - ADS Credit file denial from underwriting service
**030418** - ADS Credit file denial from underwriting service
Experience Code: 008
**030419** - ADS Credit file denial from underwriting service
Experience Code: 008
**030420** - ADS Credit file denial from underwriting service
**030421** - ADS Credit file denial from underwriting service
Experience Code: 008
**030422** - ADS Credit file denial from underwriting service
**030423** - Denied low FICO
**030424** - ADS Credit file denial from underwriting service
Experience Code: 008
**030425** - ADS Credit file denial from underwriting service
Experience Code: 008
**030426** - ADS Credit file denial from underwriting service
Experience Code: 008
**030427** - ADS Credit file denial from underwriting service
Experience Code: 008
**030428** - ADS Credit file denial from underwriting service
Experience Code: 008
**030429** - ADS Credit file denial from underwriting service
Experience Code: 008
**030430** - ADS Credit file denial from underwriting service
Experience Code: 008
**030433** - Denied low credit limit
Experience Code: 008
**030434** - SplitPay Denied Low Credit Limit & Low FICO
**030435** - Credit card debt (bankcard + retail) >50k
Experience Code: 008
**030436** - Credit card debt (bankcard + retail) <2k
Experience Code: 008
**030437** - Self reported income <20,000
Experience Code: 008
**030438** - Low vantage (<660)
**030439** - Buyer status is insolvent
**030441** - Buyer has previous credit abuse
Experience Code: 008
**030442** - Buyer is deceased per Credit Optics
Experience Code: 008
**030443** - Buyer is declined per Credit Optics
Experience Code: 008
**030444** - Buyer is deceased
Experience Code: 008
**030445** - Buyer is deceased per Precise ID
Experience Code: 008
**030446** - Buyer is declined per Precise ID
Experience Code: 008
**030447** - Buyer is deceased per Equifax
Experience Code: 008
**030448** - Miscellaneous Denials for Bureau Data reasons
Experience Code: 008
**030449** - Buyer credit score denial
Experience Code: 008
**030450** - ADS Credit file denial from underwriting service
Experience Code: 008
**030451** - ADS Credit file denial from underwriting service
Experience Code: 008
**030452** - ADS Credit file denial from underwriting service
Experience Code: 008
**030456** - Buyer credit experience denial
Experience Code: 008
**030457** - Buyer recent trades denial
Experience Code: 008
**030500** - Application transaction authorization approved for checkout
**030626** - Transaction authorization denied due to past loan overdue
**030627** - Transaction authorization denied due to Bread Pay Bread Loan 30 DPD
**040100** - Fraud pass
Experience Code: 000
**040201** - Fraud Stopped - Low risk tags
Experience Code: 009
**040202** - Fraud Stopped - High risk tags
Experience Code: 009
**040204** - Fraud Stopped - Extended fraud alert
Experience Code: 009
**040210** - Fraud Stopped - Credit Freeze
Experience Code: 006
**040211** - Fraud Stopped - Victim Statement
Experience Code: 009
**040212** - Fraud Stopped - Victim Statement No Safe Harbor
Experience Code: 001
**040213** - There is an outage with a fraud provider
Experience Code: 014
**040300** - Fraud Failed - user on blocklist (+ generic fail)
**040303** - Fraud Failed
**040305** - Applicant fails ID verification
Experience Code: 008
**040306** - Fraud Failed - Applicant fails manual review
Experience Code: 008
**040307** - Fraud - Precise ID Denied
Experience Code: 008
**040308** - Fraud Failed - Applicant fails block list check
**040309** - Fraud Denied - Deceased
Experience Code: 008
**040400** - Fraud Failed
**040500** - Fraud transaction authorization approved
Experience Code: 000
**040613** - Fraud transaction authorization denied - Marqeta Denial
**040614** - Fraud transaction authorization denied - Buyer Status Denial
**050100** - KYC Pass
Experience Code: 000
**050301** - KYC Incomplete failed
**050303** - KYC Incomplete need more info
Experience Code: 009
**050305** - KYC Incomplete credit freeze on file
**050400** - KYC failed
Experience Code: 008
**060100** - Sanctions Pass
Experience Code: 000
**060301** - Sanctions (OFAC) Stopped
Experience Code: 007
**060400** - Sanctions Stopped
Experience Code: 007
**070100** - SplitPay Checkout Complete
**070101** - SplitPay Checkout Complete
Experience Code: 000
**070201** - SplitPay payment auth failed, retry not allowed
Experience Code: 008
**070202** - SplitPay payment auth failed, retry allowed
Experience Code: 013
**080101** - Application cancelled contingent on restart with parent
Experience Code: 010
**080102** - Application cancelled partial on restart with parent
Experience Code: 010
**090000** - Virtual Card Issuance Accepted
**090100** - Virtual Card Issuance Denied - Unknown Reason
**090101** - Virtual Card Issuance Denied - Expired Card
**090102** - Virtual Card Issuance Denied - Insufficient Funds
**090103** - Virtual Card Issuance Denied - Invalid Merchant
**090104** - Virtual Card Issuance Denied - Transaction Count Limit Exceeded
**090105** - Virtual Card Issuance Denied - Transaction Not Permitted
",
"enum": [
"020101",
"020202",
"020203",
"020204",
"020205",
"020206",
"020207",
"020208",
"030101",
"030102",
"030103",
"030205",
"030209",
"030211",
"030231",
"030232",
"030240",
"030306",
"030307",
"030353",
"030354",
"030355",
"030404",
"030408",
"030410",
"030412",
"030413",
"030414",
"030415",
"030416",
"030417",
"030418",
"030419",
"030420",
"030421",
"030422",
"030423",
"030424",
"030425",
"030426",
"030427",
"030428",
"030429",
"030430",
"030433",
"030434",
"030435",
"030436",
"030437",
"030438",
"030439",
"030441",
"030442",
"030443",
"030444",
"030445",
"030446",
"030447",
"030448",
"030449",
"030450",
"030451",
"030452",
"030456",
"030457",
"030500",
"030626",
"030627",
"040100",
"040201",
"040202",
"040204",
"040210",
"040211",
"040212",
"040213",
"040300",
"040303",
"040305",
"040306",
"040307",
"040308",
"040309",
"040400",
"040500",
"040613",
"040614",
"050100",
"050301",
"050303",
"050305",
"050400",
"060100",
"060301",
"060400",
"070100",
"070101",
"070201",
"070202",
"080101",
"080102",
"090000",
"090100",
"090101",
"090102",
"090103",
"090104",
"090105"
],
"x-status-code-details": [
{
"code": "020101",
"description": "Buyer is eligible",
"domain": "ELIGIBILITY",
"status": "ELIGIBLE",
"substatus": "ELIGIBLE",
"experienceCode": "000"
},
{
"code": "020202",
"description": "Buyer is ineligible (status)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_STATUS",
"experienceCode": "008"
},
{
"code": "020203",
"description": "Buyer is ineligible (country)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_COUNTRY",
"experienceCode": "008"
},
{
"code": "020204",
"description": "Buyer is ineligible (region)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_REGION",
"experienceCode": "008"
},
{
"code": "020205",
"description": "Buyer is ineligible (age)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE",
"experienceCode": "008"
},
{
"code": "020206",
"description": "Buyer is ineligible (age - AL)",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "BUYER_AGE_AL",
"experienceCode": "002"
},
{
"code": "020207",
"description": "Buyer is ineligible due to invalid PO box address",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_POBOX",
"experienceCode": "003"
},
{
"code": "020208",
"description": "Buyer is ineligible due to address being No Match",
"domain": "ELIGIBILITY",
"status": "INELIGIBLE",
"substatus": "INVALID_ADDRESS_NOMATCH",
"experienceCode": "004"
},
{
"code": "030101",
"description": "Application approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_FULL",
"experienceCode": "000"
},
{
"code": "030102",
"description": "Application partially approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_PARTIAL",
"experienceCode": "000"
},
{
"code": "030103",
"description": "Application contingent approved for checkout",
"domain": "DECISION",
"status": "APPROVED",
"substatus": "APPROVED_CONTINGENT",
"experienceCode": "012"
},
{
"code": "030205",
"description": "Merchant/payment product configured cart size doesn't fit",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_CART",
"experienceCode": "008"
},
{
"code": "030209",
"description": "Ineligible denied in last 90 Days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "PREVIOUS_DENIAL"
},
{
"code": "030211",
"description": "Participating in Skip Payments",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "INELIGIBLE_SKIPPED_INSTALLMENTS",
"experienceCode": "008"
},
{
"code": "030231",
"description": "Max card attempts last 30 days",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_CARD_ATTEMPT",
"experienceCode": "008"
},
{
"code": "030232",
"description": "Unpaid outstanding loans",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "OUTSTANDING_LOANS",
"experienceCode": "008"
},
{
"code": "030240",
"description": "Credit pulled 5 or more times within 24 hours",
"domain": "DECISION",
"status": "INELIGIBLE",
"substatus": "MAX_BUREAU_ATTEMPTS"
},
{
"code": "030306",
"description": "Credit Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDIT_FREEZE",
"experienceCode": "005"
},
{
"code": "030307",
"description": "DOB, short SSN mismatch or Credit No Hit",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "NEEDS_FULL_IIN"
},
{
"code": "030353",
"description": "Incomplete No EFA Phone Number",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_NO_EFA_NUMBER",
"experienceCode": "001"
},
{
"code": "030354",
"description": "Incomplete Credit Optics Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_CREDITOPTICS_FREEZE",
"experienceCode": "005"
},
{
"code": "030355",
"description": "Incomplete Precise ID Freeze",
"domain": "DECISION",
"status": "INCOMPLETE",
"substatus": "INCOMPLETE_PRECISEID_FREEZE",
"experienceCode": "005"
},
{
"code": "030404",
"description": "Full SSN mismatch or credit no hit (with full SSN)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "INSUFFICIENT_DATA",
"experienceCode": "008"
},
{
"code": "030408",
"description": "Credit Denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT"
},
{
"code": "030410",
"description": "Credit freeze denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_ALERT"
},
{
"code": "030412",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_FILE",
"experienceCode": "008"
},
{
"code": "030413",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_NO_CREDIT_SCORE",
"experienceCode": "008"
},
{
"code": "030414",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_THIN_FILE",
"experienceCode": "008"
},
{
"code": "030415",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REPOSSESSIONS"
},
{
"code": "030416",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FORECLOSURE"
},
{
"code": "030417",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_DEROGATORY_RECORD"
},
{
"code": "030418",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_TRADE_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030419",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_COLLECTIONS",
"experienceCode": "008"
},
{
"code": "030420",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_CREDIT_UTILIZATION"
},
{
"code": "030421",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INSUFFICIENT_CAPACITY",
"experienceCode": "008"
},
{
"code": "030422",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_AUTHORIZED_TRADELINES"
},
{
"code": "030423",
"description": "Denied low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_FICO"
},
{
"code": "030424",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CRUST",
"experienceCode": "008"
},
{
"code": "030425",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BREAD_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030426",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE",
"experienceCode": "008"
},
{
"code": "030427",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOAN_CURRENTLY_OVERDUE",
"experienceCode": "008"
},
{
"code": "030428",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CHARGE_OFF",
"experienceCode": "008"
},
{
"code": "030429",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_ACCOUNT_PAST_DUE",
"experienceCode": "008"
},
{
"code": "030430",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_INQUIRIES",
"experienceCode": "008"
},
{
"code": "030433",
"description": "Denied low credit limit",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_CREDIT_LIMIT",
"experienceCode": "008"
},
{
"code": "030434",
"description": "SplitPay Denied Low Credit Limit & Low FICO",
"domain": "DECISION",
"status": "DENIED",
"substatus": "LOW_FICO_LOW_CREDIT_LIMIT"
},
{
"code": "030435",
"description": "Credit card debt (bankcard + retail) >50k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_HIGH",
"experienceCode": "008"
},
{
"code": "030436",
"description": "Credit card debt (bankcard + retail) <2k",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_REVOLVING_DEBT_LOW",
"experienceCode": "008"
},
{
"code": "030437",
"description": "Self reported income <20,000",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_SELF_REPORTED_INCOME",
"experienceCode": "008"
},
{
"code": "030438",
"description": "Low vantage (<660)",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_VANTAGE"
},
{
"code": "030439",
"description": "Buyer status is insolvent",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED"
},
{
"code": "030441",
"description": "Buyer has previous credit abuse",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_ABUSE",
"experienceCode": "008"
},
{
"code": "030442",
"description": "Buyer is deceased per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECEASED",
"experienceCode": "008"
},
{
"code": "030443",
"description": "Buyer is declined per Credit Optics",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDITOPTICS_DECLINE",
"experienceCode": "008"
},
{
"code": "030444",
"description": "Buyer is deceased",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DECEASED",
"experienceCode": "008"
},
{
"code": "030445",
"description": "Buyer is deceased per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECEASED",
"experienceCode": "008"
},
{
"code": "030446",
"description": "Buyer is declined per Precise ID",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_PRECISEID_DECLINE",
"experienceCode": "008"
},
{
"code": "030447",
"description": "Buyer is deceased per Equifax",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_EQUIFAX_DECEASED",
"experienceCode": "008"
},
{
"code": "030448",
"description": "Miscellaneous Denials for Bureau Data reasons",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_BUREAU_DATA",
"experienceCode": "008"
},
{
"code": "030449",
"description": "Buyer credit score denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_BUREAU",
"experienceCode": "008"
},
{
"code": "030450",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_LOW_CRUST_LOW_SCORE",
"experienceCode": "008"
},
{
"code": "030451",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_FRAUD_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030452",
"description": "ADS Credit file denial from underwriting service",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DECEASED_CHARGED_OFF",
"experienceCode": "008"
},
{
"code": "030456",
"description": "Buyer credit experience denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_CREDIT_EXPERIENCE",
"experienceCode": "008"
},
{
"code": "030457",
"description": "Buyer recent trades denial",
"domain": "DECISION",
"status": "DENIED",
"substatus": "DENIED_RECENT_TRADES",
"experienceCode": "008"
},
{
"code": "030500",
"description": "Application transaction authorization approved for checkout",
"domain": "DECISION",
"status": "TXN_AUTH_APPROVED"
},
{
"code": "030626",
"description": "Transaction authorization denied due to past loan overdue",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_PAST_LOAN_OVERDUE"
},
{
"code": "030627",
"description": "Transaction authorization denied due to Bread Pay Bread Loan 30 DPD",
"domain": "DECISION",
"status": "TXN_AUTH_DENIED",
"substatus": "DENIED_BREAD_PAY_BREAD_LOAN_30_DPD"
},
{
"code": "040100",
"description": "Fraud pass",
"domain": "FRAUD",
"status": "PASS",
"experienceCode": "000"
},
{
"code": "040201",
"description": "Fraud Stopped - Low risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "LOW_RISK",
"experienceCode": "009"
},
{
"code": "040202",
"description": "Fraud Stopped - High risk tags",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "HIGH_RISK",
"experienceCode": "009"
},
{
"code": "040204",
"description": "Fraud Stopped - Extended fraud alert",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "EXTENDED_FRAUD_ALERT",
"experienceCode": "009"
},
{
"code": "040210",
"description": "Fraud Stopped - Credit Freeze",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE",
"experienceCode": "006"
},
{
"code": "040211",
"description": "Fraud Stopped - Victim Statement",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT",
"experienceCode": "009"
},
{
"code": "040212",
"description": "Fraud Stopped - Victim Statement No Safe Harbor",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "VICTIM_STATEMENT_NO_SAFE_HARBOR",
"experienceCode": "001"
},
{
"code": "040213",
"description": "There is an outage with a fraud provider",
"domain": "FRAUD",
"status": "INCOMPLETE",
"substatus": "OUTAGE",
"experienceCode": "014"
},
{
"code": "040300",
"description": "Fraud Failed - user on blocklist (+ generic fail)",
"domain": "FRAUD",
"status": "DENIED"
},
{
"code": "040303",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "FRAUD_FAIL"
},
{
"code": "040305",
"description": "Applicant fails ID verification",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040306",
"description": "Fraud Failed - Applicant fails manual review",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "MANUAL_DENIAL",
"experienceCode": "008"
},
{
"code": "040307",
"description": "Fraud - Precise ID Denied",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "PRECISE_ID_DENIAL",
"experienceCode": "008"
},
{
"code": "040308",
"description": "Fraud Failed - Applicant fails block list check",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DENIED_BLOCKLIST_DENIAL"
},
{
"code": "040309",
"description": "Fraud Denied - Deceased",
"domain": "FRAUD",
"status": "DENIED",
"substatus": "DECEASED",
"experienceCode": "008"
},
{
"code": "040400",
"description": "Fraud Failed",
"domain": "FRAUD",
"status": "FAILED"
},
{
"code": "040500",
"description": "Fraud transaction authorization approved",
"domain": "FRAUD",
"status": "TXN_AUTH_APPROVED",
"experienceCode": "000"
},
{
"code": "040613",
"description": "Fraud transaction authorization denied - Marqeta Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "MARQETA_DENIAL"
},
{
"code": "040614",
"description": "Fraud transaction authorization denied - Buyer Status Denial",
"domain": "FRAUD",
"status": "TXN_AUTH_DENIED",
"substatus": "BUYER_STATUS_DENIAL"
},
{
"code": "050100",
"description": "KYC Pass",
"domain": "KYC",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "050301",
"description": "KYC Incomplete failed",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "FAILED"
},
{
"code": "050303",
"description": "KYC Incomplete need more info",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "NEEDS_MORE_INFO",
"experienceCode": "009"
},
{
"code": "050305",
"description": "KYC Incomplete credit freeze on file",
"domain": "KYC",
"status": "INCOMPLETE",
"substatus": "CREDIT_FREEZE"
},
{
"code": "050400",
"description": "KYC failed",
"domain": "KYC",
"status": "FAILED",
"experienceCode": "008"
},
{
"code": "060100",
"description": "Sanctions Pass",
"domain": "SANCTIONS",
"status": "PASSED",
"experienceCode": "000"
},
{
"code": "060301",
"description": "Sanctions (OFAC) Stopped",
"domain": "SANCTIONS",
"status": "INCOMPLETE",
"substatus": "FAILED",
"experienceCode": "007"
},
{
"code": "060400",
"description": "Sanctions Stopped",
"domain": "SANCTIONS",
"status": "FAILED",
"experienceCode": "007"
},
{
"code": "070100",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED"
},
{
"code": "070101",
"description": "SplitPay Checkout Complete",
"domain": "DOWN_PAYMENT_AUTH",
"status": "AUTHORIZED",
"substatus": "NONE",
"experienceCode": "000"
},
{
"code": "070201",
"description": "SplitPay payment auth failed, retry not allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "NONE",
"experienceCode": "008"
},
{
"code": "070202",
"description": "SplitPay payment auth failed, retry allowed",
"domain": "DOWN_PAYMENT_AUTH",
"status": "DECLINED",
"substatus": "DECLINED_RETRY_PAYMENT_METHOD",
"experienceCode": "013"
},
{
"code": "080101",
"description": "Application cancelled contingent on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_CONTINGENT",
"experienceCode": "010"
},
{
"code": "080102",
"description": "Application cancelled partial on restart with parent",
"domain": "CAPACITY",
"status": "CANCELLED",
"substatus": "CANCELLED_PARTIAL",
"experienceCode": "010"
},
{
"code": "090000",
"description": "Virtual Card Issuance Accepted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_ACCEPTED",
"substatus": "ACCEPTED"
},
{
"code": "090100",
"description": "Virtual Card Issuance Denied - Unknown Reason",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_UNKNOWN"
},
{
"code": "090101",
"description": "Virtual Card Issuance Denied - Expired Card",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_EXPIRED_CARD"
},
{
"code": "090102",
"description": "Virtual Card Issuance Denied - Insufficient Funds",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INSUFFICIENT_FUNDS"
},
{
"code": "090103",
"description": "Virtual Card Issuance Denied - Invalid Merchant",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_INVALID_MERCHANT"
},
{
"code": "090104",
"description": "Virtual Card Issuance Denied - Transaction Count Limit Exceeded",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_COUNT_LIMIT_EXCEEDED"
},
{
"code": "090105",
"description": "Virtual Card Issuance Denied - Transaction Not Permitted",
"domain": "VIRTUAL_CARD",
"status": "ISSUANCE_DENIED",
"substatus": "DENIED_TRANSACTION_NOT_PERMITTED"
}
]
}
},
"capacity": {
"description": "The Capacity of the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowCapacity": {
"description": "The max amount that the cart size can exceed the Offer's Capacity.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"maxConditionalCapacity": {
"description": "The max amount that the cart size has been conditionally approved.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"paymentAgreement": {
"description": "The Payment Agreement associated with the Offer.",
"allOf": [
{
"title": "OfferPaymentAgreement",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Offer Payment Agreement."
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"CANCELLED",
"CHARGED_OFF",
"CLOSED",
"EXPIRED",
"OFFERED",
"OUTSTANDING",
"PAID",
"REVIEW"
]
},
"terms": {
"type": "object",
"description": "The Terms of the Payment Agreement",
"properties": {
"interval": {
"allOf": [
{
"type": "string",
"description": "Defines set of valid term intervals for a payment product",
"enum": [
"BIWEEKLY",
"MONTHLY"
]
}
],
"description": "The Payment Interval for the Term"
},
"length": {
"type": "integer",
"format": "int64",
"description": "Length of the Term",
"example": 12
},
"rate": {
"type": "number",
"format": "float",
"description": "The Interest Rate for the Term",
"example": 5.75
},
"originalPrincipal": {
"description": "The Original Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"adjustedPrincipal": {
"description": "The Adjusted Principal amount for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceDueAtMaturity": {
"description": "The Balance Due at Maturity for the Payment Agreement.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"paymentAmount": {
"description": "The Payment Amount due each Interval for the Offer.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"balanceSummary": {
"type": "object",
"description": "The Balance Summary of the Offer",
"properties": {
"totalInterestEstimate": {
"description": "The Total Estimated Interest for this Offer",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
}
}
},
"createdAt": {
"description": "The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"shortCode": {
"description": "The Short Code of the Offer, for in-store Application.",
"allOf": [
{
"type": "object",
"title": "ShortCode",
"description": "The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.",
"properties": {
"value": {
"type": "string",
"description": "A six digit alphanumeric case insensitive value."
},
"expiresAt": {
"description": "The date-time in UTC this Short Code expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Offer was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Offer was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"capacity": {
"deprecated": true,
"description": "Deprecated - capacity is assigned per individual offer for the corresponding payment product.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
},
{
"description": "Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead."
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"status": {
"deprecated": true,
"description": "Deprecated: The status of the Application after running Start/Checkout. Use the status of the individual offers instead.",
"allOf": [
{
"title": "Status",
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
]
},
"statusCodes": {
"deprecated": true,
"description": "Deprecated: List of numerical status codes that provide more information on the reason for the Application status. Use the statusCodes of the individual offers instead.",
"type": "array",
"items": {
"type": "string",
"description": "A six digit string representing the system, status and substatus.
**010101** - Buyer hash check failed
Experience Code: 011
**010102** - Payment product not available
**010103** - Buyer/Prescreen DOB/SSN mismatch
**010200** - Application expired
**010201** - Application cancelled before scheduled expiration per buyer's request.
**010202** - Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.
**010203** - Application cancelled before scheduled expiration due to confirmed fraud.
**010304** - Application purchase window terminated on time
**010305** - Application purchase window terminated on customer closure
**010306** - Application purchase window terminated on confirmed fraud
**010307** - Application purchase window terminated on confirmed deceased
**010308** - Application purchase window terminated on confirmed bankruptcy
**010309** - Application purchase window terminated on delinquency
**010310** - Application purchase window terminated on skip payments
**010311** - Application purchase window terminated on fraud activity
**010312** - Application purchase window terminated on draw period settlement
**010313** - Application purchase window terminated on unverified fraud
",
"enum": [
"010101",
"010102",
"010103",
"010200",
"010201",
"010202",
"010203",
"010304",
"010305",
"010306",
"010307",
"010308",
"010309",
"010310",
"010311",
"010312",
"010313"
],
"x-status-code-details": [
{
"code": "010101",
"description": "Buyer hash check failed",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_HASH_CHECK_FAILED",
"experienceCode": "011"
},
{
"code": "010102",
"description": "Payment product not available",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "PAYMENT_PRODUCT_NOT_AVAILABLE"
},
{
"code": "010103",
"description": "Buyer/Prescreen DOB/SSN mismatch",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "BUYER_PRESCREEN_MISMATCH"
},
{
"code": "010200",
"description": "Application expired",
"domain": "APPLICATION",
"status": "EXPIRED"
},
{
"code": "010201",
"description": "Application cancelled before scheduled expiration per buyer's request.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REQUEST"
},
{
"code": "010202",
"description": "Application cancelled on behalf of the buyer before scheduled expiration by CS representative in order to remediate account issues.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CUSTOMER_REMEDIATION"
},
{
"code": "010203",
"description": "Application cancelled before scheduled expiration due to confirmed fraud.",
"domain": "APPLICATION",
"status": "CANCELLED",
"substatus": "APPLICATION_CANCELLED_EARLY_CONFIRMED_FRAUD"
},
{
"code": "010304",
"description": "Application purchase window terminated on time",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_ON_TIME"
},
{
"code": "010305",
"description": "Application purchase window terminated on customer closure",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CUSTOMER_CLOSURE"
},
{
"code": "010306",
"description": "Application purchase window terminated on confirmed fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_FRAUD"
},
{
"code": "010307",
"description": "Application purchase window terminated on confirmed deceased",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_DECEASED"
},
{
"code": "010308",
"description": "Application purchase window terminated on confirmed bankruptcy",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_CONFIRMED_BANKRUPTCY"
},
{
"code": "010309",
"description": "Application purchase window terminated on delinquency",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DELINQUENCY"
},
{
"code": "010310",
"description": "Application purchase window terminated on skip payments",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_SKIP_PAYMENTS"
},
{
"code": "010311",
"description": "Application purchase window terminated on fraud activity",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_FRAUD_ACTIVITY"
},
{
"code": "010312",
"description": "Application purchase window terminated on draw period settlement",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_DRAW_PERIOD_SETTLEMENT"
},
{
"code": "010313",
"description": "Application purchase window terminated on unverified fraud",
"domain": "APPLICATION",
"status": "CHECKOUT_COMPLETED",
"substatus": "PURCHASE_WINDOW_TERMINATED_UNVERIFIED_FRAUD"
}
]
}
},
"disclosures": {
"description": "The list of Disclosures the Buyer provided consent for on the Application.",
"type": "array",
"items": {
"type": "object",
"title": "Disclosure",
"description": "A representation of a Disclosure for which the Buyer must provide consent.",
"required": [
"type",
"acceptedAt"
],
"properties": {
"type": {
"type": "string",
"description": "The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.",
"example": "loan-agreement"
},
"acceptedAt": {
"description": "The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"checksum": {
"type": "string",
"description": "The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.",
"example": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
}
}
}
},
"metadata": {
"title": "Metadata",
"type": "array",
"description": "Generic metadata information for use in backend services",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Metadata."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"requestID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Request."
},
"applicationStage": {
"type": "string",
"description": "Stage of the application process for which this metadata applies.",
"enum": [
"START",
"PREPARE_CHECKOUT",
"CHECKOUT",
"UPDATE"
]
},
"key": {
"type": "string",
"description": "Metadata key name."
},
"value": {
"type": "string",
"description": "Metadata key value."
},
"createdAt": {
"description": "The date-time in UTC this Metadata was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status."
},
"retargetingURL": {
"type": "string",
"description": "Indicates the URL for retargeting.",
"example": "https://www.breadfinancial.com/"
},
"purchaseWindowStartDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was started.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expectedPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window is expected to close.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"actualPurchaseWindowCloseDate": {
"description": "The date-time in UTC that a HyLOC application's purchase window was closed.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"createdAt": {
"description": "The date-time in UTC this Application was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"expiresAt": {
"description": "The date-time in UTC this Application expires at, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"updatedAt": {
"description": "The date-time in UTC this Application was updated, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"pagination": {
"description": "The pagination information used to query.",
"type": "object",
"properties": {
"limit": {
"description": "The limit value used.",
"type": "string",
"example": "10"
},
"offset": {
"description": "The offset value used.",
"type": "string",
"example": "0"
},
"lastTimestamp": {
"description": "The timestamp value formatted per RFC3339 of the last Application from the previous page, used for keyset pagination. Depends on whether createdAt or updatedAt is used for sorting.",
"type": "string",
"format": "date-time",
"example": "2025-12-31T20:44:29.057144-04:00"
},
"lastID": {
"description": "The unique identifier of the last Application from the previous page, used for keyset pagination.",
"type": "string",
"format": "uuid",
"example": "652ee2a3-7b25-431b-bd22-0490db77c444"
},
"total": {
"description": "The total count of applications found in the database, if any.",
"type": "string",
"example": "1"
}
}
}
}
}
}
}
},
"listTxnAuthResponse": {
"description": "The list of Transaction Authorizations including pagination.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"txnAuths": {
"description": "The list of Transaction Authorizations.",
"type": "array",
"items": {
"type": "object",
"title": "TxnAuth",
"description": "The Transaction Authorization for a given Application, if any.",
"required": [
"id",
"applicationID",
"transactionID",
"authStatus",
"marqetaRTDOutcome",
"transactionAmount",
"remainingCapacity",
"errorMessage",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Transaction Authorization."
},
"applicationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Application."
},
"transactionID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Transaction."
},
"fraudResponseID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Fraud Response."
},
"decisionResponseID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Decision Response."
},
"vcCorrelationID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the VC Correlation."
},
"authStatus": {
"type": "string",
"description": "The status of the Transaction Authorization.",
"enum": [
"APPROVED",
"DENIED"
]
},
"responseStatus": {
"type": "string",
"description": "The status of the Subsystem Transaction Authorization check.",
"enum": [
"APPROVED",
"DENIED",
"FRAUD_PASS",
"FRAUD_FAIL"
]
},
"responseSubStatus": {
"type": "string",
"description": "The sub-status of the Subsystem Transaction Authorization check.",
"enum": [
"TRANSACTION_AUTH_UNKNOWN_SUBSTATUS",
"TRANSACTION_AUTH_DENIED_LOAN_CURRENTLY_OVERDUE",
"UNKNOWN",
"MARQETA_DENIAL",
"BUYER_STATUS_DENIAL"
]
},
"responseStatusCode": {
"type": "string",
"description": "A six digit string that represents the system, status and substatus of the Subsystem Transaction Authorization check",
"example": "100101"
},
"marqetaRTDOutcome": {
"type": "string",
"description": "Marqeta Real-time decisioning Outcome."
},
"transactionAmount": {
"description": "Transaction amount on the HyLOC",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
],
"example": {
"value": 200000,
"currency": "USD"
}
},
"remainingCapacity": {
"description": "Remaining capacity on the HyLOC",
"type": "integer",
"example": 40000
},
"errorMessage": {
"description": "The error message of the Transaction Authorization, if any.",
"format": "string"
},
"createdAt": {
"description": "The date-time in UTC this Transaction Authorization was created, represented as RFC3339 format.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
}
}
}
},
"pagination": {
"description": "The pagination information used to query.",
"type": "object",
"properties": {
"limit": {
"description": "The limit value used.",
"type": "string",
"example": "10"
},
"lastTimestamp": {
"description": "The timestamp value formatted per RFC3339 of the last Application from the previous page, used for keyset pagination. Depends on whether createdAt or updatedAt is used for sorting.",
"type": "string",
"format": "date-time",
"example": "2025-12-31T20:44:29.057144-04:00"
},
"lastID": {
"description": "The unique identifier of the last Transaction Authorization from the previous page, used for keyset pagination.",
"type": "string",
"format": "uuid",
"example": "652ee2a3-7b25-431b-bd22-0490db77c444"
},
"total": {
"description": "The total count of transaction authorizations found in the database, if any.",
"type": "string",
"example": "1"
}
}
}
}
}
}
}
},
"applicationErrorResponse": {
"description": "Error response for application errors",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 404,
"message": "Application could not be found with the provided ID.",
"domain": "Application",
"metadata": {},
"reason": "Application_Not_Found"
}
}
}
},
"tooManyRequestsErrorResponse": {
"description": "The caller has exceeded the allowed request rate. Retry after a short back-off period.",
"content": {
"application/json": {
"schema": {
"title": "ApplicationError",
"type": "object",
"description": "Default error model for application errors",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
},
{
"properties": {
"reason": {
"type": "string",
"description": "A machine-readable reason code identifying the specific error condition. Possible values and their meanings:\n\n- `Application_Not_Found`: No Application exists for the provided ID within the caller's scope.\n- `Short_Code_Not_Found`: No in-store short code exists matching the provided value.\n- `Tenant_Not_Found`: The Tenant ID derived from the JWT could not be found.\n- `Buyer_Not_Found`: The Buyer ID derived from the JWT or request could not be found.\n- `Location_Not_Found`: The Location ID provided in the request extensions could not be found.\n- `Merchant_Not_Found`: The Merchant ID derived from the JWT or request could not be found.\n- `Payment_Agreement_Not_Found`: No Payment Agreement exists for the provided Agreement ID.\n- `Offer_Not_Found`: No Offer exists for the provided Offer ID.\n- `Start_Request_Validation`: One or more fields in the Start Application request failed validation. Check the `metadata` field for per-field details.\n- `Checkout_Request_Validation`: One or more fields in the Checkout request failed validation. Check the `metadata` field for per-field details.\n- `Prescreen_Request_Validation`: One or more fields in the Prescreen request failed validation.\n- `Eligibility_Request_Validation`: One or more fields in the Eligibility request failed validation.\n- `List_Request_Validation`: One or more query parameters in the List Applications request failed validation.\n- `Request_Validation`: One or more fields in the request failed validation.\n- `Invalid_Request_Body`: The request body could not be parsed as valid JSON.\n- `Too_Many_Requests`: The request was rejected due to rate limiting. Retry after a short back-off period.\n- `Missing_Required_IDs`: The JWT is missing required identity claims (e.g. tenantID).\n- `Disclosure_Invalid`: One or more disclosures failed validation (e.g. invalid checksum or missing required type).\n- `Invalid_Application_Status`: The Application is not in a status that permits the requested operation.\n- `Invalid_Offer_Status`: The Offer is not in a status that permits the requested operation.\n- `ApplicationExpired`: The Application has passed its expiration time and can no longer be used.\n- `Short_Code_Expired`: The in-store short code associated with the Application has expired.\n- `Application_Not_Expired`: A request was made that requires the Application to be expired, but it has not expired yet.\n- `Down_Payment_Failure`: The down-payment payment method authorization failed during Checkout.\n- `Down_Payments_Not_Enabled`: Down payments are not enabled for this Program or Merchant-Program configuration.\n- `Payment_Method_Not_Found`: No Payment Method exists for the provided Payment Method ID.\n- `Failed_Transaction_Auth_Check`: The transaction authorization check against the buyer's account failed.\n- `Purchase_Window_Closed`: The HyLOC purchase window has been closed; the transaction cannot be authorized.\n- `Purchase_Window_Closed_Prior_To_Request`: The HyLOC purchase window was already closed before this request was received.\n- `Expected_Purchase_Window_Close_Date_Not_Set`: The expected purchase-window close date was not set before a subsequent transaction authorization was attempted.\n- `Invalid_Payment_Product`: The Payment Product associated with the Application is not valid for the requested operation.\n- `Insufficient_Remaining_Capacity`: The transaction amount exceeds the Application's remaining capacity.\n- `Invalid_Program_Checkout_Mode`: The Program's configured checkout mode does not match the type of checkout being attempted.\n- `Merchant_Is_Not_Bopis_Enabled`: The Merchant is not configured for Buy Online, Pickup In-Store (BOPIS) checkout.\n- `Resource_Forbidden`: The JWT does not have sufficient privileges to perform this action on the requested resource.\n- `Dependency_Response_Invalid`: A required downstream service returned a response that could not be processed.\n- `Dependency_Response_Error`: A required downstream service returned an unrecoverable error.\n- `Dependency_Unavailable`: A required downstream service did not respond or is unavailable.\n- `Service_Unavailable`: The Application service is temporarily unable to process the request.",
"enum": [
"Application_Not_Found",
"Short_Code_Not_Found",
"Tenant_Not_Found",
"Buyer_Not_Found",
"Location_Not_Found",
"Merchant_Not_Found",
"Payment_Agreement_Not_Found",
"Offer_Not_Found",
"Start_Request_Validation",
"Checkout_Request_Validation",
"Prescreen_Request_Validation",
"Eligibility_Request_Validation",
"List_Request_Validation",
"Request_Validation",
"Invalid_Request_Body",
"Too_Many_Requests",
"Missing_Required_IDs",
"Disclosure_Invalid",
"Invalid_Application_Status",
"Invalid_Offer_Status",
"ApplicationExpired",
"Short_Code_Expired",
"Application_Not_Expired",
"Down_Payment_Failure",
"Down_Payments_Not_Enabled",
"Payment_Method_Not_Found",
"Failed_Transaction_Auth_Check",
"Purchase_Window_Closed",
"Purchase_Window_Closed_Prior_To_Request",
"Expected_Purchase_Window_Close_Date_Not_Set",
"Invalid_Payment_Product",
"Insufficient_Remaining_Capacity",
"Invalid_Program_Checkout_Mode",
"Merchant_Is_Not_Bopis_Enabled",
"Resource_Forbidden",
"Dependency_Response_Invalid",
"Dependency_Response_Error",
"Dependency_Unavailable",
"Service_Unavailable"
],
"example": "Application_Not_Found"
}
}
}
]
},
"example": {
"code": 429,
"message": "Too many requests.",
"domain": "Application",
"metadata": {},
"reason": "Too_Many_Requests"
}
}
}
},
"VcErrorResponse": {
"description": "Response for errors returned by virtual_card service.",
"content": {
"application/json": {
"schema": {
"description": "Represents an error returned by virtual_card service.",
"type": "object",
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"properties": {
"reason": {
"type": "string",
"description": "Virtual Card error reason codes",
"enum": [
"Unauthorized",
"Request_Validation",
"Bad_Request",
"Not_Found",
"Unable_to_Authorize",
"Unable_to_Settle",
"Internal_Server_Failure"
],
"example": "Unauthorized"
}
},
"example": {
"message": "Bad Request",
"reason": "Bad_Request",
"domain": "",
"metadata": {},
"code": 400
}
}
}
}
},
"DefaultError": {
"description": "Default error response for any errors in the API",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"required": [
"code",
"domain",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The underlying http status code",
"format": "int32",
"example": 500
},
"message": {
"type": "string",
"description": "A simple message in english describing the error and can be returned to the consumer",
"example": "Age cannot be less than 18"
},
"domain": {
"type": "string",
"description": "The domain where the error is originating from as defined by the service",
"example": "Payments"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs",
"example": {
"propertyName": "propertyName is required"
}
}
}
}
],
"required": [
"code",
"domain",
"message",
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain",
"example": "Reason_Code"
}
}
}
}
}
}
},
"parameters": {
"agreementIDPath": {
"name": "agreementID",
"in": "path",
"required": true,
"description": "The unique identifier of the Payment Agreement.",
"schema": {
"type": "string",
"format": "uuid"
}
},
"applicationIDPath": {
"name": "applicationID",
"in": "path",
"required": true,
"description": "The unique identifier of the Application.",
"schema": {
"type": "string",
"format": "uuid"
}
},
"shortcode": {
"name": "shortcode",
"in": "path",
"required": true,
"description": "The short code for an instore application.",
"schema": {
"type": "string",
"pattern": "^[A-Z0-9]{6}$",
"example": "A1B2C3"
}
},
"showExpiredQuery": {
"name": "showExpired.eq",
"in": "query",
"required": false,
"description": "Show expired applications. Defaults to true.",
"schema": {
"type": "boolean"
}
},
"normalizedAddressHashQuery": {
"name": "normalizedAddressHash.eq",
"in": "query",
"required": false,
"description": "Show applications associated with provided normalized address hash.",
"schema": {
"type": "string",
"format": "sha256"
}
},
"metadataQuery": {
"name": "metadata.eq",
"in": "query",
"description": "Show metadata associated with the application. Defaults to false.",
"required": false,
"schema": {
"type": "boolean"
}
},
"updatedAtFromQuery": {
"name": "updatedAt.gte",
"in": "query",
"description": "The lower bound of the date range, inclusive.",
"required": false,
"schema": {
"type": "string",
"format": "YYYY-MM-DD"
}
},
"updatedAtToQuery": {
"name": "updatedAt.lte",
"in": "query",
"description": "The upper bound of the date range, inclusive.",
"required": false,
"schema": {
"type": "string",
"format": "YYYY-MM-DD"
}
},
"buyerIDQuery": {
"name": "buyerID.eq",
"in": "query",
"description": "The unique identifier of the Buyer.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"merchantIDQuery": {
"name": "merchantID.eq",
"in": "query",
"description": "The unique identifier of the Merchant. Must match merchantID on the JWT if provided.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"statusQuery": {
"name": "status.eq",
"in": "query",
"description": "The status to filter the Application records by.",
"required": false,
"schema": {
"type": "string",
"enum": [
"APPROVED",
"ATTEMPTED_CHECKOUT",
"ATTEMPTED_PREPARE_CHECKOUT",
"CANCELLED",
"CHECKOUT_EXTENDED",
"CHECKOUT_COMPLETED",
"CHECKOUT_PREPARED",
"DENIED",
"EXPIRED",
"INELIGIBLE",
"NEEDS_ACTION",
"STARTED"
]
}
},
"statusCodeQuery": {
"name": "statusCode.eq",
"in": "query",
"description": "The status code to filter the Application records by.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "array",
"minItems": 0,
"items": {
"type": "string",
"pattern": "^[0-9]{6}$",
"example": "030101"
}
}
},
"statusCodeNotEqualQuery": {
"name": "statusCode.ne",
"in": "query",
"description": "The status code that don't match to filter the Application records by.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "array",
"minItems": 0,
"items": {
"type": "string",
"pattern": "^[0-9]{6}$",
"example": "030101"
}
}
},
"lastTimestampQuery": {
"name": "lastTimestamp.eq",
"in": "query",
"description": "The timestamp value formatted per RFC3339 of the last Application from the previous page, used for keyset pagination. Depends on whether createdAt or updatedAt is used for sorting.",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T20:44:29.057144-04:00"
}
},
"lastIDQuery": {
"name": "lastID.eq",
"in": "query",
"description": "The unique identifier of the last ID from the previous page, used for keyset pagination.",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"example": "652ee2a3-7b25-431b-bd22-0490db77c444"
}
},
"sortQuery": {
"name": "sort",
"in": "query",
"description": "Specifies the sort order for paginated results. Accepts createdAt or updatedAt fields with ascending or descending order.",
"required": false,
"schema": {
"type": "string",
"enum": [
"createdAt.asc",
"createdAt.desc",
"updatedAt.asc",
"updatedAt.desc"
]
}
},
"limitQuery": {
"in": "query",
"name": "limit",
"description": "The maximum number of records that will be returned in a result set.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 200,
"default": 10
},
"example": 50
},
"offsetQuery": {
"in": "query",
"name": "offset",
"description": "The number of records to skip before starting to collect the result set. Used in conjunction with limit query parameter for pagination support",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0
},
"example": 20
},
"showArchived": {
"in": "query",
"name": "showArchived",
"description": "Indicates that any archived records if available will be returned as part of the results",
"required": false,
"allowEmptyValue": true,
"schema": {
"type": "boolean",
"default": false
}
}
},
"requestBodies": {
"IssueVirtualCardRequestBody": {
"content": {
"application/json": {
"schema": {
"description": "Issuance data required for creating a virtual card",
"type": "object",
"required": [
"scopeID",
"scopeType",
"buyerID",
"programID"
],
"properties": {
"scopeType": {
"description": "Scope type of the issuance.",
"type": "string",
"enum": [
"APPLICATION",
"MERCHANT"
],
"example": "APPLICATION"
},
"scopeID": {
"description": "Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"programID": {
"description": "ID of the program associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"buyerID": {
"description": "ID of the buyer associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
},
"applicationSettings": {
"description": "Additional metadata if the scopeType is APPLICATION.",
"type": "object",
"properties": {
"merchantID": {
"description": "ID of the merchant associated with this issuance.",
"type": "string",
"format": "uuid",
"example": "e3b1d6f5-bc6a-4835-b40e-5f1a22dacf6a"
}
},
"example": {
"merchantID": "d8a265ce-5d9c-4d0b-9edd-401450f78e09"
}
}
},
"example": {
"scopeType": "APPLICATION",
"scopeID": "a2b1fa94-98fc-4de3-9b76-7c0de89fcbb1",
"programID": "0efc5a37-96fe-4636-9966-bf3ab26c3f29",
"buyerID": "c1c1fdd1-811c-4ea2-bf37-2af9ea348299",
"applicationSettings": {
"merchantID": "e3b1d6f5-bc6a-4835-b40e-5f1a22dacf6a"
}
}
}
}
},
"description": "Virtual card issuance request",
"required": true
},
"IssueApplePayRequestBody": {
"content": {
"application/json": {
"schema": {
"description": "ApplePay issuance request",
"type": "object",
"properties": {},
"example": {}
}
}
},
"description": "ApplePay digital token issuance request",
"required": true
},
"IssueGooglePayRequestBody": {
"content": {
"application/json": {
"schema": {
"description": "GooglePay issuance request",
"type": "object",
"required": [
"serverSessionId",
"clientSessionId",
"tokenSetting",
"cardSetting",
"publicWalletId",
"publicDeviceId",
"integratorId"
],
"properties": {
"serverSessionId": {
"type": "string",
"example": "8c84fab9-889c-4cb7-a330-accac5799ea5",
"description": "A string that identifies the backend session. Provided by Google pay backend."
},
"clientSessionId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "A string that identifies the client session. Provided by Google pay backend."
},
"tokenSetting": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "1 => Tokenization will be attempted.; 0 => Tokenization will not be attempted.",
"enum": [
0,
1
]
},
"cardSetting": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "1 => FPAN save will be attempted.; 0 => FPAN save will not be attempted.",
"enum": [
0,
1
]
},
"publicWalletId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "String identifying the device-scoped Google Pay wallet that will receive the token. Provided by Google Pay backend."
},
"publicDeviceId": {
"type": "string",
"example": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"description": "String identifying the Android device that will receive the token. Provided by Google Pay backend"
},
"integratorId": {
"type": "string",
"example": "ACMEISSUER_1",
"description": "A Google-assigned string that uniquely identifies both the integrator that is initiating the session and the issuer of the payment card."
}
},
"example": {
"serverSessionId": "8c84fab9-889c-4cb7-a330-accac5799ea5",
"clientSessionId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"tokenSetting": 1,
"cardSetting": 1,
"publicWalletId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"publicDeviceId": "5855opl9-abcc-4cb7-a330-xyze5799ea5",
"integratorId": "ACMEISSUER_1"
}
}
}
},
"description": "GooglePay digital token issuance request",
"required": true
},
"UpdateCardStatusRequestBody": {
"content": {
"application/json": {
"schema": {
"description": "Update issuance status request",
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"SUSPENDED",
"TERMINATED"
],
"description": "String that identifies which status to update to"
}
}
}
}
},
"description": "Update issuance status request",
"required": true
}
},
"securitySchemes": {
"bearerAuthApplication": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "The scoped JWT provided by the Auth service."
},
"bearerAuthVirtualCard": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "The JWT access token provided by the Auth service."
}
}
}
}