{"openapi":"3.0.0","info":{"title":"PAY. Transaction Gateway Unit API's","description":"A restful journey to your payments.","termsOfService":"https://www.pay.nl/en/terms-conditions","contact":{"email":"support@pay.nl"},"version":"v2.0"},"servers":[{"url":"https://rest.pay.nl/v2","description":"PAY. API server"},{"url":"https://rest.letspay.nl/v2"},{"url":"https://rest.fasterpay.nl/v2"},{"url":"https://rest.premium-pay.nl/v2"},{"url":"https://rest.letspin.nl/v2"},{"url":"https://rest.achterelkebetaling.nl/v2"},{"url":"https://rest.payments.nl/v2"}],"paths":{"/transactions/find":{"get":{"tags":["Transactions"],"summary":"Transaction:Find","description":"Find a transaction based on the provided search criteria","parameters":[{"name":"needle","in":"query","description":"The search term (or \"needle\") used to find transactions. This parameter is a string that can be a keyword, transaction ID, reference number, or part of a transaction detail.\n      The API will return transactions that match the `needle` string, which is applied to various fields such as the transaction description, amount, date, or reference number.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"toothpaste"}},"type":"object"}}],"responses":{"200":{"description":"Ok.","content":{"application/json":{"schema":{"properties":{"total":{"type":"integer"},"count":{"type":"integer"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/TransactionFind"}}},"type":"object"},"examples":{"success":{"$ref":"#/components/examples/TransactionFindResponse200Successful"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"429":{"$ref":"#/components/responses/RateLimiting"},"500":{"description":"An internal error occurred"}},"security":[{"basicAuth":[]}]}},"/transactions":{"get":{"tags":["Transactions"],"summary":"Transaction:Browse","description":"Retrieve the transactions for a merchant up to 10.000 transaction limited to 100 trx per page and maximum 100 pages.","parameters":[{"name":"limit","in":"query","description":"Limit the returned records. If not supplied we will default to 100 records","schema":{"type":"integer","default":100,"maximum":100,"minimum":1}},{"name":"page","in":"query","description":"Indicate which page you want in your result set. If not supplied we will default to page 1","schema":{"type":"integer","default":1}},{"name":"id","in":"query","description":"The Id of the transaction.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"EX-1234-1234-1234"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"EX-1234-1234-1234"},"in":{"description":"Get results that correspond to one of the provided values.","type":"string","example":"EX-1234-1234-1234"},"nin":{"description":"Get results that do not correspond to one of the provided values.","type":"string","example":"EX-1234-1234-1234"}},"type":"object"}},{"name":"amount","in":"query","description":"The amount in cents.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"integer","example":10},"neq":{"description":"Get results that do not equal the given value","type":"integer","example":10},"gt":{"description":"Get results that are greater than the given value","type":"integer","example":10},"gte":{"description":"Get results that are greater than or equal to the given value","type":"integer","example":10},"lt":{"description":"Get results that are less than the given value","type":"integer","example":10},"lte":{"description":"Get results that are less than or equal to the given value","type":"integer","example":10}},"type":"object"}},{"name":"amountRefunded","in":"query","description":"The amount already refunded in cents.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"integer","example":10},"neq":{"description":"Get results that do not equal the given value","type":"integer","example":10},"gt":{"description":"Get results that are greater than the given value","type":"integer","example":10},"gte":{"description":"Get results that are greater than or equal to the given value","type":"integer","example":10},"lt":{"description":"Get results that are less than the given value","type":"integer","example":10},"lte":{"description":"Get results that are less than or equal to the given value","type":"integer","example":10}},"type":"object"}},{"name":"date","in":"query","description":"The date and time when the transaction was created. Provide a value in either Y-m-d or Y-m-d H:i:s format.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value. Supported format is Y-m-d.","type":"string","format":"date","example":"1999-02-15"},"neq":{"description":"Get results that do not equal the given value. Supported format is Y-m-d.","type":"string","format":"date","example":"1999-02-15"},"gt":{"description":"Get results that are greater than the given value. Supported formats are Y-m-d or Y-m-d H:i:s","type":"string","format":"date","example":"1999-02-15 12:31:30"},"gte":{"description":"Get results that are greater than or equal to the given value. Supported formats are Y-m-d or Y-m-d H:i:s","type":"string","format":"date","example":"1999-02-15 12:31:30"},"lt":{"description":"Get results that are less than the given value. Supported formats are Y-m-d or Y-m-d H:i:s","type":"string","format":"date","example":"1999-02-15 12:31:30"},"lte":{"description":"Get results that are less than or equal to the given value. Supported formats are Y-m-d or Y-m-d H:i:s","type":"string","format":"date","example":"1999-02-15 12:31:30"}},"type":"object"}},{"name":"orderId","in":"query","description":"The orderId of the transaction.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"0000000000X00000"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"0000000000X00000"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"0000000000X00000"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"0000000000X00000"}},"type":"object"}},{"name":"description","in":"query","description":"Is shown on the statement of the payer.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"Example description."},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"Example description."},"like":{"description":"Get results that are similar to the given value","type":"string","example":"Example description."},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"Example description."}},"type":"object"}},{"name":"status","in":"query","description":"The status code of the transaction.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"integer","example":100},"neq":{"description":"Get results that do not equal the given value","type":"integer","example":100},"in":{"description":"Get results that correspond to one of the provided values.","type":"integer","example":100},"nin":{"description":"Get results that do not correspond to one of the provided values.","type":"integer","example":100}},"type":"object"}},{"name":"extra1","in":"query","description":"The first free value which can be tracked in the stats.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"extra1"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"extra1"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"extra1"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"extra1"}},"type":"object"}},{"name":"extra2","in":"query","description":"The second free value which can be tracked in the stats.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"extra2"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"extra2"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"extra2"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"extra2"}},"type":"object"}},{"name":"extra3","in":"query","description":"The third free value which can be tracked in the stats.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"extra3"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"extra3"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"extra3"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"extra3"}},"type":"object"}},{"name":"object","in":"query","description":"The object which can be tracked in stats.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"object"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"object"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"object"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"object"}},"type":"object"}},{"name":"reference","in":"query","description":"The reference of the transaction","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"abcdef"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"abcdef"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"abcdef"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"abcdef"}},"type":"object"}},{"name":"customer-email","in":"query","description":"The email of the consumer that started the transaction.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"info@mycompany.nl"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"info@mycompany.nl"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"info@mycompany.nl"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"info@mycompany.nl"}},"type":"object"}},{"name":"accountnumber","in":"query","description":"The account number of the consumer that started the transaction.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"NL69INGB0123456789"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"NL69INGB0123456789"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"NL69INGB0123456789"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"NL69INGB0123456789"}},"type":"object"}},{"name":"customer-name","in":"query","description":"The name of the customer that started the transaction.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"John Doe"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"John Doe"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"John Doe"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"John Doe"}},"type":"object"}},{"name":"ip-address","in":"query","description":"Ip address of the customer from the transaction.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"John Doe"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"John Doe"},"like":{"description":"Get results that are similar to the given value","type":"string","example":"John Doe"},"nlike":{"description":"Get results that are not similar to the given value","type":"string","example":"John Doe"}},"type":"object"}},{"name":"country","in":"query","description":"The country in which this transaction was started.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"NL"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"NL"},"in":{"description":"Get results that correspond to one of the provided values.","type":"string","example":"NL"},"nin":{"description":"Get results that do not correspond to one of the provided values.","type":"string","example":"NL"}},"type":"object"}},{"name":"paymentMethod","in":"query","description":"The payment profile identifier.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"integer","example":"1630"},"neq":{"description":"Get results that do not equal the given value","type":"integer","example":"1630"},"in":{"description":"Get results that correspond to one of the provided values.","type":"integer","example":"1630"},"nin":{"description":"Get results that do not correspond to one of the provided values.","type":"integer","example":"1630"}},"type":"object"}},{"name":"paymentMethodBrand","in":"query","description":"The identifier of the payment profile brand.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"integer","example":"1"},"neq":{"description":"Get results that do not equal the given value","type":"integer","example":"1"},"in":{"description":"Get results that correspond to one of the provided values.","type":"integer","example":"1"},"nin":{"description":"Get results that do not correspond to one of the provided values.","type":"integer","example":"1"}},"type":"object"}},{"name":"paymentMethodGroup","in":"query","description":"payment method group id","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"integer","example":4},"neq":{"description":"Get results that do not equal the given value","type":"integer","example":4},"in":{"description":"Get results that correspond to one of the provided values.","type":"integer","example":4},"nin":{"description":"Get results that do not correspond to one of the provided values.","type":"integer","example":4}},"type":"object"}},{"name":"service","in":"query","description":"The service code for which the transaction was started.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"SL-1234-4321"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"SL-1234-4321"},"in":{"description":"Get results that correspond to one of the provided values.","type":"string","example":"SL-1234-4321"},"nin":{"description":"Get results that do not correspond to one of the provided values.","type":"string","example":"SL-1234-4321"}},"type":"object"}},{"name":"merchant","in":"query","description":"The code of the merchant for which the transaction was started.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"string","example":"M-####-####"},"neq":{"description":"Get results that do not equal the given value","type":"string","example":"M-####-####"},"in":{"description":"Get results that correspond to one of the provided values.","type":"string","example":"M-####-####"},"nin":{"description":"Get results that do not correspond to one of the provided values.","type":"string","example":"M-####-####"}},"type":"object"}},{"name":"testMode","in":"query","description":"Filter transactions by test mode. true for test mode transactions, false for production transactions.","style":"deepObject","explode":true,"schema":{"properties":{"eq":{"description":"Get results that equal the given value","type":"boolean","example":true},"neq":{"description":"Get results that do not equal the given value","type":"boolean","example":false}},"type":"object"}}],"responses":{"200":{"description":"Ok.","content":{"application/json":{"schema":{"properties":{"total":{"type":"integer"},"count":{"type":"integer"},"pages":{"type":"integer"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/TransactionFind"}}},"type":"object"},"examples":{"success":{"$ref":"#/components/examples/TransactionBrowseResponse200Successful"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"429":{"$ref":"#/components/responses/RateLimiting"},"500":{"description":"An internal error occurred"}},"security":[{"basicAuth":[]}]}},"/transactions/{transactionId}":{"get":{"tags":["Transactions"],"summary":"Transaction:Info","description":"Get all detailed information of a transaction. You can use the EX code or the order ID to retrieve the detailed transaction information","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Transaction/properties/id"}}],"responses":{"200":{"description":"Ok.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"},"examples":{"success":{"$ref":"#/components/examples/TransactionResponse200Successful"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"429":{"$ref":"#/components/responses/RateLimiting"},"500":{"description":"An internal error occurred"}},"security":[{"basicAuth":[]}]}}},"components":{"schemas":{"Address":{"properties":{"code":{"type":"string"},"firstName":{"$ref":"#/components/schemas/Customer/properties/firstName"},"lastName":{"$ref":"#/components/schemas/Customer/properties/lastName"},"streetName":{"description":"The name of the street","type":"string","maxLength":128,"minLength":1,"example":"Visitlane"},"streetNumber":{"description":"The street number","type":"string","maxLength":32,"minLength":1,"example":"13"},"streetNumberExtension":{"description":"A house number extension is required to deal with appartments or other addresses sharing the same front door","type":"string","maxLength":32,"minLength":1,"example":"b1"},"zipCode":{"description":"A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country.","type":"string","maxLength":16,"minLength":1,"example":"5678CD"},"city":{"description":"The name of a city","type":"string","maxLength":128,"minLength":1,"example":"Amsterdam"},"regionCode":{"description":"Region code (iso-3166-2)","type":"string","example":"ZH"},"countryCode":{"description":"The country code consisting of 2 uppercase letters","type":"string","maxLength":2,"minLength":2,"example":"NL"}},"type":"object"},"Amount":{"required":["value"],"properties":{"value":{"description":"The amount in cents.","type":"integer","minimum":1,"example":10},"currency":{"description":"The currency in ISO-4217 format.","type":"string","example":"EUR"}},"type":"object"},"BankAccount":{"required":["iban","bic","owner"],"properties":{"iban":{"description":"The International Bank Account Number (IBAN).","type":"string","example":"NL69INGB0123456789"},"bic":{"description":"Business Identifier Codes (BIC/SWIFT).","type":"string","example":"INGBNL2A"},"owner":{"description":"The owner of the bank account.","type":"string","maxLength":64,"minLength":1,"example":"John Doe"}},"type":"object"},"Company":{"properties":{"name":{"description":"The name of your merchant.","type":"string","example":"CompanyName"},"coc":{"description":"Your Chamber of commerce registration number. This format differs per country.","type":"string","example":"12345678"},"vat":{"description":"Value added tax identification number (VAT identification number).","type":"string","example":"NL807960147B01"},"countryCode":{"description":"The country code consisting of 2 uppercase letters","type":"string","example":"NL"}},"type":"object"},"Customer":{"properties":{"firstName":{"description":"The forename (also known as a given name, Christian name or a first name).","type":"string","maxLength":64,"minLength":1,"example":"John"},"lastName":{"description":"The surname (also known as a family name or a last name).","type":"string","maxLength":64,"minLength":1,"example":"Doe"},"type":{"description":"Either B for business or C for consumer.","type":"string","enum":["B","C"]},"ip":{"description":"An ip address","type":"string","example":"213.126.82.230"},"birthDate":{"description":"Date of birth as defined in ISO-8601.","type":"string","format":"date","example":"1999-02-15"},"gender":{"description":"The subject's gender. Choose either M for male or F for female.","type":"string","example":"M"},"phone":{"description":"The subject's phone number. Optionally prepended with a + and country code","type":"string","example":"0031612345678"},"email":{"description":"An email address.","type":"string","format":"email","example":"sandbox@pay.nl"},"language":{"description":"The language code consisting of 2 uppercase letters. Can be one of the following: EN, NL, DE, FR, ES, IT. You can find all available languages here: https://paynl.readme.io/reference/languages","type":"string","enum":["NL","EN","DE","FR","IT","ES"],"example":"NL"},"trust":{"description":"Indicates whether you trust the payer, scale -10 -> 10 (10 Reliable, -10 Unreliable).","type":"integer","maximum":10,"minimum":-10,"example":-5},"reference":{"description":"Unique reference of the payer. This field only allows alphanumeric characters.","type":"string","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9]{1,64}$","example":"NL87654321"},"bankAccount":{"$ref":"#/components/schemas/BankAccount"},"company":{"$ref":"#/components/schemas/Company"}},"type":"object"},"Integration":{"properties":{"testMode":{"description":"Indicates if the service is in testmode or not, possible values: false or true","type":"boolean"}},"type":"object"},"Order":{"properties":{"countryCode":{"description":"When used this countryCode takes preference over the one set in the deliveryAddress and is then used as the countryCode for this transaction","type":"string","maxLength":2,"minLength":2,"example":"NL"},"deliveryDate":{"description":"The date of delivery.","type":"string","format":"date","example":"1999-02-15"},"invoiceDate":{"description":"The date of the invoice","type":"string","format":"date","example":"1999-02-15"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"invoiceAddress":{"$ref":"#/components/schemas/Address"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}},"type":"object"},"PaymentMethod":{"required":["id"],"properties":{"id":{"description":"The ID of the payment option e.g. iDEAL is 10. See: services/get/sl-xxxx-xxx.","type":"integer","example":"10"},"subId":{"description":"The chosen sub ID of the payment option e.g. The bank id for iDEAL. See: services/get/sl-xxxx-xxx.","type":"string","example":"10"},"name":{"description":"The name of the payment method.","type":"string","example":"ideal"},"terminalCode":{"description":"The terminalCode of the payment terminal used for in-store transactions.","type":"string","example":"TH-####-####"}},"type":"object"},"PaymentMethodBrand":{"properties":{"id":{"description":"The identifier of the payment profile brand.","type":"integer","example":"1"},"name":{"description":"The name of the payment profile brand.","type":"string","example":"iDEAL"}},"type":"object"},"Product":{"properties":{"id":{"description":"The product identifier.","type":"string","example":"TEST_01"},"description":{"description":"The description of the product.","type":"string","example":"Some product description"},"type":{"description":"The type of product. More information can be found here: https://paynl.readme.io/reference/producttypes","type":"string","enum":["shipping","article","discount","rounding","handling","payment","credit","giftcard","emoney","crypto"]},"price":{"properties":{"value":{"description":"The amount in cents.","type":"integer","minimum":1,"example":10}},"type":"object"},"quantity":{"description":"The quantity.","type":"number","format":"float"},"vatCode":{"description":"The VAT code to use.","type":"string","enum":["N","H","L"]}},"type":"object"},"Service":{"properties":{"id":{"description":"The ID of your service. You can find the service ID in the portal.","type":"string","example":"SL-####-####"},"name":{"description":"The name of your service.","type":"string","example":"My first service!"},"description":{"description":"The description of the service.","type":"string"},"testMode":{"description":"Indicates if the service is in testmode or not, possible values: false or true","type":"integer"},"secret":{"description":"The unique reference for this service.","type":"string","example":"bade123abf124124abefa311b"},"createdAt":{"$ref":"#/components/schemas/Universal/properties/createdAt"}},"type":"object"},"Stats":{"properties":{"info":{"description":"The used info code which can be tracked in the stats.","type":"string","maxLength":64,"minLength":1,"example":"Campagne 99"},"tool":{"description":"The used tool code which can be tracked in the stats.","type":"string","maxLength":64,"minLength":1,"example":"Google"},"object":{"description":"The object which can be tracked in stats.","type":"string","maxLength":64,"minLength":1},"extra1":{"description":"The first free value which can be tracked in the stats.","type":"string","maxLength":64,"minLength":1,"example":"Customer 6985615"},"extra2":{"description":"The second free value which can be tracked in the stats.","type":"string","maxLength":64,"minLength":1,"example":"Invoice 21.3695"},"extra3":{"description":"The third free value which can be tracked in the stats.","type":"string","maxLength":64,"minLength":1,"example":"Shop Amsterdam"},"domainId":{"description":"The ID of the duplicate content URL","type":"string","example":"WU-####-####"}},"type":"object"},"Status":{"properties":{"code":{"description":"The status code.","type":"integer"},"action":{"description":"The state in which the transaction resides","type":"string","example":"PAID"},"phase":{"description":"The current phase in the transaction state","type":"string","example":"APPROVED"}},"type":"object"},"TransactionFind":{"properties":{"id":{"$ref":"#/components/schemas/Transaction/properties/id"},"orderId":{"$ref":"#/components/schemas/Transaction/properties/orderId"},"description":{"$ref":"#/components/schemas/Transaction/properties/description"},"reference":{"$ref":"#/components/schemas/Transaction/properties/reference"},"amount":{"$ref":"#/components/schemas/Amount"},"amountRefunded":{"$ref":"#/components/schemas/Amount"},"service":{"properties":{"code":{"description":"The service code for which the transaction was started.","type":"string","example":"SL-1234-4321"},"name":{"description":"The name of the service for which the transaction was started.","type":"string","example":"Ticket sales"}},"type":"object"},"paymentData":{"properties":{"customerId":{"$ref":"#/components/schemas/TransactionStatusPaymentData/properties/customerId"},"customerKey":{"$ref":"#/components/schemas/TransactionStatusPaymentData/properties/customerKey"},"customerName":{"$ref":"#/components/schemas/TransactionStatusPaymentData/properties/customerName"},"ipAddress":{"$ref":"#/components/schemas/TransactionStatusPaymentData/properties/ipAddress"},"secureStatus":{"$ref":"#/components/schemas/TransactionStatusPaymentData/properties/secureStatus"}},"type":"object"},"status":{"$ref":"#/components/schemas/Status"},"paymentMethodBrand":{"$ref":"#/components/schemas/PaymentMethodBrand"},"paymentMethod":{"$ref":"#/components/schemas/TransactionStatusPaymentMethod"},"integration":{"$ref":"#/components/schemas/Integration"},"customer":{"properties":{"reference":{"$ref":"#/components/schemas/Customer/properties/reference"},"firstName":{"$ref":"#/components/schemas/Customer/properties/firstName"},"lastName":{"$ref":"#/components/schemas/Customer/properties/lastName"},"email":{"$ref":"#/components/schemas/Customer/properties/email"}},"type":"object"},"orderDeliveryCountryCode":{"description":"The code for the country the order will/has been delivered to.","type":"string","example":"NL"},"createdAt":{"$ref":"#/components/schemas/Universal/properties/createdAt"},"createdBy":{"$ref":"#/components/schemas/Universal/properties/createdBy"},"completedAt":{"description":"The date at which the transaction was fully completed.","type":"string","example":"2019-01-01T12:00:00+02:00"},"expiredAt":{"description":"Expire date in the correct ISO-8601 (a.k.a. ATOM) notation.","type":"string","format":"date-time","readOnly":true,"nullable":true}},"type":"object"},"TransactionStatusPaymentData":{"properties":{"method":{"description":"Payment method of the transaction.","type":"string"},"customerKey":{"description":"Customer key of the customer from the transaction.","type":"string"},"customerId":{"description":"Customer id of the customer from the transaction.","type":"string"},"customerName":{"description":"Customer name of the customer from the transaction.","type":"string"},"ipAddress":{"description":"Ip address of the customer from the transaction.","type":"string"},"secureStatus":{"description":"Secure status of the transaction.","type":"boolean"},"paymentVerificationMethod":{"type":"integer"}},"type":"object"},"TransactionStatusPaymentMethod":{"properties":{"id":{"description":"The ID of the payment option e.g. iDEAL is 10. See: services/get/sl-xxxx-xxx.","type":"integer"},"subId":{"description":"The chosen sub ID of the payment option e.g. The bank id for iDEAL. See: services/get/sl-xxxx-xxx.","type":"integer"}},"type":"object"},"TransferData":{"properties":{"name":{"description":"The name of the variable to be tracked in the transaction.","type":"string","example":"stat1"},"value":{"description":"The value of the variable to be tracked in the transaction.","type":"string","example":"ab8827dfc"}},"type":"object"},"Universal":{"properties":{"translations":{"description":"Object containing all the translations with the property name in which the corresponds with a property on the object itself.","type":"object","uniqueItems":true,"example":"\n    \"translations\": {\n      \"name\": {\n        ...\n      },\n      \"description\": {\n        ...\n      }\n    }\n","nullable":true,"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"requiredFields":{"description":"The required fields of the payment method.","type":"array","items":{"properties":{"fieldName":{"type":"string"},"mandatory":{"type":"string"}},"type":"object"}},"createdAt":{"description":"The creation date time presented in the correct ISO-8601 (a.k.a. ATOM) notation","type":"string","format":"date-time","readOnly":true,"example":"2016-06-04T08:15:00+01:00","nullable":false},"createdBy":{"description":"The reference to an account or token whom created the entity","type":"string","pattern":"^A(T)?(-\\d{4}){2}$","readOnly":true,"example":"A-1234-4321","nullable":false},"modifiedAt":{"description":"The modification date time presented in the correct ISO-8601 (a.k.a. ATOM) notation","type":"string","format":"date-time","readOnly":true,"example":"2016-06-04T08:15:00+01:00","nullable":true},"modifiedBy":{"description":"The reference to an account or token whom modified the entity","type":"string","pattern":"^A(T)?(-\\d{4}){2}$","readOnly":true,"example":"A-1234-4321","nullable":true},"deletedAt":{"description":"The deletion date time presented in the correct ISO-8601 (a.k.a. ATOM) notation. Can be empty (null)","type":"string","format":"date-time","readOnly":true,"example":"2016-06-04T08:15:00+01:00","nullable":true},"deletedBy":{"description":"The reference to an account or token whom deleted the entity","type":"string","pattern":"^A(T)?(-\\d{4}){2}$","readOnly":true,"example":"A-1234-4321","nullable":true}},"type":"object"},"Transaction":{"required":["serviceId","amount","returnUrl"],"properties":{"id":{"description":"The Id of the transaction.","type":"string","example":"EX-1234-1234-1234"},"serviceId":{"$ref":"#/components/schemas/Service/properties/id"},"description":{"description":"Is shown on the statement of the payer.","type":"string","maxLength":32,"minLength":1,"example":"Example description."},"reference":{"description":"The merchant identification of this transaction. This field only allows alphanumeric characters","type":"string","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9]{1,64}$","example":"12345XXY0123"},"manualTransferCode":{"description":"Payment reference used to identify manual bank transfers","type":"string","example":"0000 0000 0000 0000"},"orderId":{"description":"The orderId of the transaction.","type":"string","example":"0000000000X00000"},"ipAddress":{"description":"An ip address","type":"string","example":"213.126.82.230"},"exchangeUrl":{"description":"The URL where we exchange the status of a transaction.","type":"string","format":"uri","example":"https://demo.pay.nl/exchange.php"},"returnUrl":{"description":"The URL where the payer has to be send to after the payment.","type":"string","format":"uri","example":"https://demo.pay.nl/complete/"},"paymentUrl":{"description":"The payment URL for this transaction","type":"string","format":"uri"},"amount":{"$ref":"#/components/schemas/Amount"},"expire":{"description":"Expire date in the correct ISO-8601 (a.k.a. ATOM) notation.","type":"string","format":"date-time","example":"2016-06-04T08:15:00+01:00"},"created":{"description":"The date at which this entity was created presented in the correct ISO-8601 (a.k.a. ATOM) notation.","type":"string","format":"date-time","readOnly":true,"example":"2016-06-04T08:15:00+01:00"},"modified":{"description":"The date at which this entity was modified presented in the correct ISO-8601 (a.k.a. ATOM) notation.","type":"string","format":"date-time","readOnly":true,"example":"2016-06-04T08:15:00+01:00"},"amountConverted":{"$ref":"#/components/schemas/Amount"},"amountPaid":{"$ref":"#/components/schemas/Amount"},"amountRefunded":{"$ref":"#/components/schemas/Amount"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"status":{"$ref":"#/components/schemas/Status"},"integration":{"$ref":"#/components/schemas/Integration"},"customer":{"$ref":"#/components/schemas/Customer"},"order":{"$ref":"#/components/schemas/Order"},"stats":{"$ref":"#/components/schemas/Stats"},"type":{"description":"Defines the type of the transaction. Possible values are: CIT = Customer initiated simple e-com transaction, MIT = Merchant initiated transaction, MOTO = Customer initiated payment where card number entered manually, POS = Point of sale, ECOM","type":"string","enum":["POS","ECOM","CIT","MIT","MOTO"]},"transferData":{"type":"array","items":{"$ref":"#/components/schemas/TransferData"},"xml":{"name":"transferData","wrapped":true}}},"type":"object","xml":{"name":"transaction"}}},"responses":{"BadRequest":{"description":"Bad request, see response body for more information"},"Unauthorized":{"description":"Unauthorized. Supplied credentials are invalid"},"Forbidden":{"description":"Forbidden. Supplied credentials have no rights"},"NotFound":{"description":"Not found"},"MethodNotAllowed":{"description":"Used HTTP method is not allowed"},"NotAcceptable":{"description":"Not acceptable. The supplied content type in the accept parameter in the header is not supported"},"RateLimiting":{"description":"Rate limit reached."}},"examples":{"TransactionBrowseResponse200Successful":{"summary":"Transaction browse","value":{"total":5,"count":1,"pages":5,"transactions":[{"id":"EX-1234-5678-9012","orderId":"00000000000X0000","description":"My order desc","reference":"","amount":{"value":1250,"currency":"EUR"},"amountRefunded":{"value":50,"currency":"EUR"},"service":{"code":"SL-1234-5678","name":"T-shirt Shop"},"paymentData":{"customerId":"NL69INGB0123456789","customerKey":"somekeyvalue","customerName":"John Doe","ipAddress":"10.11.12.13","secureStatus":false},"status":{"code":100,"action":"PAID","phase":"PAID"},"paymentMethodBrand":{"id":1,"name":"iDEAL"},"paymentMethod":{"id":10,"subId":4,"name":"IDEAL","terminalCode":"TH-####-####"},"integration":{"testMode":false},"customer":{"reference":"my-reference","firstName":"John","lastName":"Doe","email":"example@test.com"},"orderDeliveryCountryCode":"NL","createdAt":"2024-05-26T01:52:59+02:00","createdBy":"A-1234-5678","completedDate":"2024-06-03T01:52:59+02:00","expiresAt":"2024-06-02T01:52:59+02:00"}],"_links":{"first":{"href":"\\/transactions?limit=1&page=1"},"previous":{"href":"\\/transactions?limit=1&page=1"},"next":{"href":"\\/transactions?limit=1&page=2"},"last":{"href":"\\/transactions?limit=1&page=5"},"self":{"href":"\\/transactions?limit=1","rel":"self","type":"GET"}}}},"TransactionFindResponse200Successful":{"summary":"Transaction Find","value":{"total":5,"count":1,"transactions":[{"id":"EX-1234-5678-9012","orderId":"00000000000X0000","description":"My order desc","reference":"","amount":{"value":1250,"currency":"EUR"},"amountRefunded":{"value":50,"currency":"EUR"},"service":{"code":"SL-1234-5678","name":"T-shirt Shop"},"paymentData":{"customerId":"NL69INGB0123456789","customerKey":"somekeyvalue","customerName":"John Doe","ipAddress":"10.11.12.13","secureStatus":false},"status":{"code":100,"action":"PAID","phase":"PAID"},"paymentMethodBrand":{"id":1,"name":"iDEAL"},"paymentMethod":{"id":10,"subId":4,"name":"IDEAL"},"integration":{"testMode":false},"customer":{"reference":"my-reference","firstName":"John","lastName":"Doe","email":"example@test.com"},"orderDeliveryCountryCode":"NL","createdAt":"2024-05-26T01:52:59+02:00","createdBy":"A-1234-5678","completedDate":"2024-06-03T01:52:59+02:00","expiresAt":"2024-06-02T01:52:59+02:00"}],"_links":{"first":{"href":"\\/transactions?limit=1&page=1"},"previous":{"href":"\\/transactions?limit=1&page=1"},"next":{"href":"\\/transactions?limit=1&page=2"},"last":{"href":"\\/transactions?limit=1&page=5"},"self":{"href":"\\/transactions?limit=1","rel":"self","type":"GET"}}}},"TransactionResponse200Successful":{"summary":"Transaction Full","value":{"id":"EX-0171-7899-4460","orderId":"1234567891X33ce1","serviceCode":"SL-4878-2340","description":"Example description","reference":"12345XXY0123","ipAddress":"86.83.126.161","amount":{"value":10,"currency":"EUR"},"amountConverted":{"value":10,"currency":"EUR"},"amountPaid":{"value":0,"currency":"EUR"},"amountRefunded":{"value":0,"currency":"EUR"},"status":{"code":100,"action":"PAID","phase":"SUCCESS"},"paymentData":{"method":"iban","customerKey":"07e384a630c97ef7e1f1fb8b2edbf8ac","customerId":"NL91ABNA0417164300","customerName":"John Doe","ipAddress":"213.126.82.230","secureStatus":false,"paymentVerificationMethod":16,"iban":{"iban":"NL69INGB0123456789","bic":"INGBNL2A","owner":"John Doe"}},"paymentMethod":{"id":10,"subId":3,"name":"iDEAL","terminalCode":"TH-####-####","billingLineId":3762},"customer":{"firstName":"John","lastName":"Doe","type":"B","birthDate":"1999-02-15","language":"NL","gender":"M","phone":"0031612345678","email":"sandbox@pay.nl","trust":0,"reference":"NL87654321","bankAccount":{"iban":"NL69INGB0123456789","bic":"INGBNL2A","owner":"John Doe"},"company":{"name":"CompanyName","coc":"12345678","vat":"NL0123456789","countryCode":"NL"}},"order":{"countryCode":"NL","deliveryDate":"2022-12-30","invoiceDate":"2022-12-30","deliveryAddress":{"firstName":"John","lastName":"Doe","streetName":"Deliverylane","streetNumber":70,"streetNumberExtension":"A","zipCode":"5678CD","city":"Amsterdam","regionCode":"NH","countryCode":"NL"},"invoiceAddress":{"firstName":"Samanta","lastName":"Doe - Jones","streetName":"Invoicestreet","streetNumber":2,"streetNumberExtension":"B","zipCode":"5211","city":"London","regionCode":"LND","countryCode":"UK"},"products":[{"id":"Telefoon","type":"article","description":"iPhone 12 Pro","price":{"value":5,"currency":"EUR"},"quantity":1,"vatCode":"H"},{"id":"TV","type":"article","description":"Samsung TV","price":{"value":5,"currency":"EUR"},"quantity":1,"vatCode":"H"}]},"stats":{"info":"","tool":"","object":"","extra1":"76908","extra2":"","extra3":"","domainId":null},"transferData":[],"expiresAt":"2021-09-04T12:14:01+02:00","createdAt":"2021-09-04T12:14:01+02:00","createdBy":"AT-1234-4321","modifiedAt":null,"modifiedBy":null,"deletedAt":null,"deletedBy":null,"_links":[{"href":"/transactions/EX-0171-7899-4460/status","rel":"self","type":"GET"}]}}},"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"name":"Transactions","description":""}],"externalDocs":{"description":"Official PAY. documentation","url":"https://docs.pay.nl"}}