--- updatedAt: 2026-06-30T07:46:06.000Z agentTools: projectIndex: https://developer.pay.nl/llms.txt --- # Order:Approve Approve an order that is flagged for a risk check by the Verify module, continuing the regular order flow. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Pay. Transaction Gateway Unit API", "description": "The restful API for interacting with the Pay. Transaction Gateway Unit.", "contact": { "name": "Pay.", "url": "https://www.pay.nl", "email": "support@pay.nl" }, "version": "1" }, "servers": [ { "url": "https://connect.pay.nl", "description": "Multicore (Default)" }, { "url": "https://connect.payments.nl", "description": "Payments" }, { "url": "https://connect.achterelkebetaling.nl", "description": "Achterelkebetaling" }, { "url": "https://zero.pay.nl", "description": "ZERO" } ], "paths": { "/v1/orders/{id}/approve": { "patch": { "operationId": "api_approve_order", "tags": [ "Order" ], "responses": { "200": { "description": "Order approved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order.Output" }, "examples": { "success": { "$ref": "#/components/examples/OrderResponse200Approve" } } }, "application/vnd.validation+json": { "schema": { "$ref": "#/components/schemas/Order.Output" }, "examples": { "success": { "$ref": "#/components/examples/OrderResponse200Approve" } } } } }, "400": { "description": "Invalid input", "content": { "application/vnd.validation+json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/vnd.validation+json": { "schema": { "type": "object" } } } }, "404": { "description": "Resource not found", "content": { "application/vnd.validation+json": { "schema": { "type": "object" } } } }, "422": { "description": "Unprocessable entity", "content": { "application/vnd.validation+json": { "schema": { "type": "object" } } } } }, "summary": "Order:Approve", "description": "Approve an order that is flagged for a risk check by the Verify module, continuing the regular order flow.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the order", "required": true, "deprecated": false, "schema": { "type": "string", "example": "9f5cc332-8cd7-4242-b9c8-51941aa12837" }, "style": "simple", "explode": false } ], "deprecated": false }, "parameters": [] } }, "components": { "schemas": { "Order.Output": { "type": "object", "description": "", "deprecated": false, "properties": { "id": { "description": "The unique identifier of your order.", "example": "655b2da5-5223-8f32-1aee-737862302XXX", "type": "string" }, "type": { "description": "The order type.", "example": "sale", "type": "string" }, "serviceId": { "description": "The Service ID used for creating this order", "example": "SL-####-####", "type": "string" }, "description": { "description": "The description given for this order.", "example": "Instore Terminal Order #27", "type": [ "string", "null" ] }, "reference": { "description": "The reference given for this order.", "example": "REF1234", "type": [ "string", "null" ] }, "manualTransferCode": { "description": "The manual transfer code that can be used to transfer the order amount to PAY. using a bank transfer.", "example": "1234 1234 1234 1234", "type": "string" }, "orderId": { "description": "The order ID as you would see it within the PAY. platform.", "example": "52305407020X2325", "type": "string" }, "uuid": { "description": "The UUID that can be used to create a QR code for this order.", "example": "ad0e7378-6230-2325-5230-5407020a2XXX", "type": "string" }, "customerKey": { "readOnly": true, "description": "An identifier for the customer", "type": [ "string", "null" ] }, "status": { "description": "The status of the order.", "$ref": "#/components/schemas/Order.Output.Status" }, "receipt": { "readOnly": true, "description": "Base64 encoded string of the receipt for this order when it's paid.", "example": "", "type": [ "string", "null" ] }, "integration": { "description": "Information about your integration.", "$ref": "#/components/schemas/Order.Output.Integration" }, "splitPayments": { "readOnly": true, "type": "array", "items": { "$ref": "#/components/schemas/Order.Output.SplitPayment" } }, "stats": { "description": "Contains the statsData object as given when the order was created.", "$ref": "#/components/schemas/Order.Output.Stats" }, "transferData": { "description": "Contains the transferData values given when the order was created.", "type": "object", "additionalProperties": { "type": "integer" } }, "amount": { "description": "The amount for this order.", "$ref": "#/components/schemas/Order.Output.Amount" }, "authorizedAmount": { "description": "The amount of the order that is authorized.", "$ref": "#/components/schemas/Order.Output.Amount" }, "capturedAmount": { "description": "The amount of the order that is captured.", "$ref": "#/components/schemas/Order.Output.Amount" }, "checkoutData": { "readOnly": true, "description": "Standardized customer data provided by the supplier", "anyOf": [ { "$ref": "#/components/schemas/Order.Output.CheckoutData" }, { "type": "null", "title": "null" } ] }, "payments": { "readOnly": true, "description": "The payments that are linked to this order.", "type": "array", "items": { "$ref": "#/components/schemas/Order.Output.Payment" } }, "createdAt": { "description": "The date-time at which this order was created in our system.", "type": "string", "format": "date-time" }, "createdBy": { "description": "The API token or Service ID that created this order.", "type": [ "string", "null" ] }, "modifiedAt": { "description": "The date-time at which this order was modified in our system. This can be done by you or by actions taken within our order-payment flow.", "type": [ "string", "null" ], "format": "date-time" }, "modifiedBy": { "description": "The API token or Service ID that did the modification of the order. This can also be the TGU node that was handling the order-payment flow.", "type": [ "string", "null" ] }, "expiresAt": { "description": "The date-time at which this order expires.", "type": "string", "format": "date-time" }, "completedAt": { "description": "The date-time at which this order was completed. This means that all underlying payments are captured and money is guaranteed.", "type": [ "string", "null" ], "format": "date-time" }, "links": { "readOnly": true, "description": "The links that can be used to interact with this order.", "example": { "redirect": "", "status": "", "cancel": "" }, "type": "object", "additionalProperties": { "type": "string" } } } }, "Order.Output.Amount": { "type": "object", "description": "", "deprecated": false, "properties": { "value": { "example": 1, "type": "integer" }, "currency": { "example": "EUR", "type": "string" } } }, "Order.Output.CheckoutData": { "type": "object", "description": "", "deprecated": false, "properties": { "customer": { "description": "The customer provided by the supplier", "$ref": "#/components/schemas/Order.Output.CheckoutData.Customer" }, "billingAddress": { "readOnly": true, "description": "The billing address provided by the supplier", "$ref": "#/components/schemas/Order.Output.CheckoutData.Address" }, "shippingAddress": { "description": "The delivery address provided by the supplier", "$ref": "#/components/schemas/Order.Output.CheckoutData.Address" } } }, "Order.Output.CheckoutData.Address": { "type": "object", "description": "", "deprecated": false, "properties": { "firstName": { "example": "John", "type": [ "string", "null" ] }, "lastName": { "example": "Doe", "type": [ "string", "null" ] }, "streetName": { "example": "Curieweg", "type": [ "string", "null" ] }, "streetNumber": { "example": "19", "type": [ "string", "null" ] }, "streetNumberAddition": { "example": "C", "type": [ "string", "null" ] }, "zipCode": { "example": "3208 KJ", "type": [ "string", "null" ] }, "city": { "example": "Spijkenisse", "type": [ "string", "null" ] }, "countryCode": { "example": "NL", "type": [ "string", "null" ] }, "regionCode": { "example": "nl-ZH", "type": [ "string", "null" ] } } }, "Order.Output.CheckoutData.Company": { "type": "object", "description": "", "deprecated": false, "properties": { "name": { "example": "Pay.", "type": [ "string", "null" ] }, "cocNumber": { "example": "24283498", "type": [ "string", "null" ] }, "vatNumber": { "example": "NL807960147B01", "type": [ "string", "null" ] }, "country": { "example": "NL", "type": [ "string", "null" ] } } }, "Order.Output.CheckoutData.Customer": { "type": "object", "description": "", "deprecated": false, "properties": { "email": { "example": "johndoe@example.com", "type": [ "string", "null" ] }, "firstName": { "example": "John", "type": [ "string", "null" ] }, "lastName": { "example": "Doe", "type": [ "string", "null" ] }, "dateOfBirth": { "example": "1999-11-22", "type": [ "string", "null" ], "format": "date-time" }, "gender": { "example": "O", "type": [ "string", "null" ] }, "phone": { "example": "06-12345678", "type": [ "string", "null" ] }, "locale": { "example": "nl_BE", "type": [ "string", "null" ] }, "ipAddress": { "example": "192.168.0.1", "type": [ "string", "null" ] }, "reference": { "example": "Cstmr12", "type": [ "string", "null" ] }, "company": { "anyOf": [ { "$ref": "#/components/schemas/Order.Output.CheckoutData.Company" }, { "type": "null", "title": "null" } ] } } }, "Order.Output.Integration": { "type": "object", "description": "", "deprecated": false, "properties": { "pointOfInteraction": { "type": [ "string", "null" ] }, "test": { "description": "Whether this order was created in Test Mode, defaults to false.", "type": "boolean" } } }, "Order.Output.Payment": { "type": "object", "description": "", "deprecated": false, "properties": { "id": { "description": "The unique ID of this payment", "example": "2d29c301-c71d-4016-8239-4ee3194a234e", "type": "string" }, "paymentMethod": { "description": "Information of this payments' payment method.", "$ref": "#/components/schemas/PaymentMethodOutputDto-generic.api" }, "billingLineId": { "description": "The capture payment profile id.", "type": [ "integer", "null" ] }, "customerType": { "type": [ "string", "null" ] }, "customerKey": { "description": "A hashed string identifying the customer itself without exposing sensitive data.", "example": "5d7dbff5bf0a64c7e3d9dbd8806d2b55d3d67731", "type": [ "string", "null" ] }, "customerId": { "description": "The identifier of the customer as known by the payment method. For example the IBAN.", "example": "GB33BUKB20201555555555", "type": [ "string", "null" ] }, "customerName": { "description": "The name of the customer as known by the payment method.", "type": [ "string", "null" ] }, "customerMethod": { "description": "The payment method used by the payer, including details such as card data or IBAN number.", "anyOf": [ { "$ref": "#/components/schemas/Order.Payment.PayerMethod" }, { "type": "null", "title": "null" } ] }, "ipAddress": { "description": "The IP Address of the customer that interacted with this payment.", "type": [ "string", "null" ] }, "secureStatus": { "description": "Whether or not the customer was 3DS challenged.", "type": "boolean" }, "paymentVerificationMethod": { "description": "A numeric id of how this payment was verified.", "type": [ "integer", "null" ] }, "status": { "description": "The status of this payment.", "$ref": "#/components/schemas/Order.Output.Status" }, "currencyAmount": { "description": "The amount of this payment in the currency of the order.", "$ref": "#/components/schemas/Order.Output.Amount" }, "amount": { "description": "The amount of this payment in the currency in which it was processed.", "$ref": "#/components/schemas/Order.Output.Amount" }, "authorizedAmount": { "description": "The amount of this payment that is authorized.", "$ref": "#/components/schemas/Order.Output.Amount" }, "capturedAmount": { "description": "The amount of this payment that is captured.", "$ref": "#/components/schemas/Order.Output.Amount" }, "supplierData": { "description": "Relevant data returned by the supplier.", "type": [ "array", "null" ], "items": { "type": "string" } }, "recurring": { "description": "Whether or not recurring is enabled for this payment", "type": "boolean" }, "externalId": { "description": "The external ID of this payment", "example": "2d29c301-c71d-4016-8239-4ee3194a234e", "type": [ "string", "null" ] } } }, "Order.Output.SplitPayment": { "type": "object", "description": "", "deprecated": false, "properties": { "serviceId": { "type": "string" }, "amount": { "$ref": "#/components/schemas/Order.Output.Amount" }, "fee": { "type": "string", "enum": [ "receiver", "sender" ] } } }, "Order.Output.Stats": { "type": "object", "description": "", "deprecated": false, "properties": { "extra1": { "description": "The first free value which can be tracked in the stats.", "example": "Extra1", "type": [ "string", "null" ] }, "extra2": { "description": "The second free value which can be tracked in the stats.", "example": "Extra2", "type": [ "string", "null" ] }, "extra3": { "description": "The third free value which can be tracked in the stats.", "example": "Extra3", "type": [ "string", "null" ] }, "tool": { "description": "The used tool code which can be tracked in the stats.", "example": "Tool", "type": [ "string", "null" ] }, "info": { "description": "The used info code which can be tracked in the stats.", "example": "Info", "type": [ "string", "null" ] }, "object": { "description": "The object which can be tracked in stats.", "example": "Object", "type": [ "string", "null" ] }, "promotorId": { "example": "8763", "type": [ "integer", "null" ] }, "domainId": { "example": "WU-1234-1234", "type": [ "string", "null" ] } } }, "Order.Output.Status": { "type": "object", "description": "", "deprecated": false, "properties": { "code": { "description": "The numeric status code.", "example": 20, "type": "integer" }, "name": { "description": "The human readable status string.", "example": "pending", "type": "string" }, "action": { "description": "The human readable status group string.", "example": "PENDING", "type": "string" } } }, "Order.Payment.PayerMethod": { "type": "object", "description": "", "deprecated": false, "properties": { "type": { "readOnly": true, "type": "string" }, "data": { "readOnly": true, "type": "object", "anyOf": [ { "$ref": "#/components/schemas/Order.Payment.PayerMethod.Iban" }, { "$ref": "#/components/schemas/Order.Payment.PayerMethod.Card" } ] } } }, "PaymentMethodOutputDto-generic.api": { "type": "object", "description": "", "deprecated": false, "properties": { "id": { "type": [ "integer", "null" ] }, "input": { "type": "array", "items": { "type": "string" } } } }, "Order.Payment.PayerMethod.Iban": { "type": "object", "description": "", "deprecated": false, "properties": { "iban": { "example": "NL05ABNA8014558928", "type": "string" }, "name": { "example": "Pay.nl", "type": "string" }, "bic": { "example": "RABONL2U", "type": "string" } } }, "Order.Payment.PayerMethod.Card": { "type": "object", "description": "", "deprecated": false, "properties": { "maskedPan": { "example": "123456******4321", "type": "string" }, "issuerId": { "example": "123456", "type": "string" }, "scheme": { "example": "MASTERCARD", "type": "string" }, "countryCode": { "example": "840", "type": "string" }, "cardType": { "example": "commercial", "type": "string" }, "fundingType": { "example": "credit", "type": "string" }, "brandCode": { "example": "MCC", "type": "string" }, "brandName": { "example": "MasterCard® Credit", "type": "string" }, "brandProduct": { "example": "MAB", "type": "string" } } } }, "examples": { "OrderResponse200Approve": { "summary": "Approved order", "description": "Approved order", "value": { "id": "01a0a599-5e44-70ef-bbeb-dd44f9453e1f", "type": "sale", "serviceId": "SL-####-####", "description": "Instore Terminal Order #27", "reference": "REF1234", "manualTransferCode": "0000 0000 0000 0000", "orderId": "0000", "uuid": "01a0a599-5e44-70ef-bbeb-dd44f9453e1f", "customerKey": null, "status": { "code": 100, "name": "captured", "action": "PAID" }, "receipt": null, "integration": { "pointOfInteraction": null, "test": false }, "splitPayments": [], "stats": { "extra1": "extra1", "extra2": "extra2", "extra3": "extra3", "tool": "tool", "info": "info", "object": "object", "promotorId": 0, "domainId": "WU-1234-5678" }, "transferData": { "key": "value" }, "amount": { "value": 100, "currency": "EUR" }, "authorizedAmount": { "value": 0, "currency": "EUR" }, "capturedAmount": { "value": 100, "currency": "EUR" }, "checkoutData": null, "payments": [ { "id": "01a0a599-5e47-7f1a-a2e1-63dc913b8478", "paymentMethod": { "id": 10, "input": null }, "billingLineId": 10, "customerType": null, "customerKey": null, "customerId": null, "customerName": null, "customerMethod": null, "ipAddress": "127.0.0.1", "secureStatus": true, "paymentVerificationMethod": 21, "status": { "code": 100, "name": "captured", "action": "PAID" }, "currencyAmount": { "value": 100, "currency": "EUR" }, "amount": { "value": 100, "currency": "EUR" }, "authorizedAmount": { "value": 0, "currency": "EUR" }, "capturedAmount": { "value": 0, "currency": "EUR" }, "supplierData": null, "recurring": false, "externalId": null } ], "createdAt": "2026-09-15T17:04:46+02:00", "createdBy": "AT-1234-1234", "modifiedAt": "2026-09-15T17:05:46+02:00", "modifiedBy": "TGU 123456", "expiresAt": "2026-09-15T17:19:46+02:00", "completedAt": null, "links": { "status": "", "abort": "", "redirect": "" } } } }, "securitySchemes": { "BasicAuth": { "type": "http", "description": "", "scheme": "basic" }, "BearerAuth": { "type": "http", "description": "Example: Bearer 12345xx6xxx1x2x123456789123xx123x12345x4", "scheme": "bearer" } } }, "security": [ { "BasicAuth": [] }, { "BearerAuth": [] } ] } ```