--- updatedAt: 2026-04-20T20:05:09.000Z agentTools: projectIndex: https://docs.prahsys.com/llms.txt --- # Update or Create Payment # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Payments API", "description": "", "version": "1.81.0" }, "servers": [ { "url": "https://api.prahsys.com" } ], "tags": [ { "name": "Payments", "description": "" } ], "components": { "securitySchemes": { "default": { "type": "http", "scheme": "bearer", "description": "You can retrieve your API key from your Prahsys account manager." } } }, "security": [ { "default": [] } ], "paths": { "/payments/n1/merchant/{merchantId}/payment/{paymentId}": { "post": { "summary": "Update or Create Payment", "operationId": "updateOrCreatePayment", "description": "", "parameters": [ { "in": "header", "name": "X-Prahsys-Version", "description": "", "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response from updating or creating a payment (Full Example)", "content": { "application/json": { "schema": { "type": "object", "example": { "success": true, "data": { "id": "payment-c0ab7cf63263a85", "merchantId": "Z70B874W63DW", "orderId": "order_az78bt57", "amount": 70.05, "currency": "USD", "description": "This is an example payment", "custom": { "merchantReference": "REF-1800-lmba" }, "type": "PRIMARY", "invoiceNumber": "b91a4e68-401a-327f-b804-e3aae625c677", "certainty": "FINAL", "statementDescriptor": { "name": "Bins-Homenick", "phone": "209-814-4110", "websiteUrl": "http://sauer.com/vero-odio-nesciunt-quae-aut-sequi", "address": { "street": "133 Myrtle Pass", "city": "East Lucianochester", "stateProvince": "AR", "postcodeZip": "55443", "country": "USA" } }, "status": "CAPTURED", "creationTime": "2026-01-18T18:48:18.000+00:00", "lastUpdatedTime": "2026-01-29T08:55:31.000+00:00", "result": "SUCCESS", "billing": { "card": { "nameOnCard": "John Doe", "number": "424242xxxxxx4242", "expiry": { "month": 1, "year": 39 }, "brand": "VISA", "fundingMethod": "DEBIT", "storedOnFile": "NOT_STORED" }, "address": { "id": "311c6267-d349-38d9-b5d0-77d29f5ca1e9", "isDefault": true, "company": "Boyer Group", "street": "511 Hirthe Views Suite 229", "street2": "Suite 996", "city": "West Arnold", "stateProvince": "KY", "postcodeZip": "91911", "country": "USA" }, "method": "CARD" }, "customer": { "email": "test.customer@example.com", "firstName": "Elsie", "lastName": "Kautzer", "phone": "+18578674736", "dateOfBirth": "1975-08-07" }, "refundedAmount": 0, "refundableAmount": 70.05, "receiptUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85", "receiptPdfUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85/download", "dashboardUrl": "https://dashboard.prahsys.com/example-channel/merchants/example-merchant/orders/payment-c0ab7cf63263a85", "tags": [ "retail", "recurring" ], "transactions": [ { "id": "e8025759-596a-3c8f-8cab-ad9e83a9f69f", "operation": "AUTHORIZE", "type": "AUTHORIZATION", "result": "SUCCESS", "settlementStatus": "SETTLED", "amount": 70.05, "currency": "USD", "payment": { "id": "payment-c0ab7cf63263a85", "merchantId": "Z70B874W63DW", "orderId": "order_az78bt57", "amount": 70.05, "currency": "USD", "description": "This is an example payment", "custom": { "merchantReference": "REF-1800-lmba" }, "type": "PRIMARY", "invoiceNumber": "b91a4e68-401a-327f-b804-e3aae625c677", "statementDescriptor": { "name": "Bins-Homenick", "phone": "209-814-4110", "websiteUrl": "http://sauer.com/vero-odio-nesciunt-quae-aut-sequi", "address": { "street": "133 Myrtle Pass", "city": "East Lucianochester", "stateProvince": "AR", "postcodeZip": "55443", "country": "USA" } }, "certainty": "FINAL", "status": "CAPTURED", "creationTime": "2026-01-18T18:48:18.000+00:00", "lastUpdatedTime": "2026-01-29T08:55:31.000+00:00", "result": "SUCCESS", "billing": { "card": { "nameOnCard": "John Doe", "number": "424242xxxxxx4242", "expiry": { "month": 1, "year": 39 }, "brand": "VISA", "fundingMethod": "DEBIT", "storedOnFile": "NOT_STORED" }, "address": { "id": "311c6267-d349-38d9-b5d0-77d29f5ca1e9", "isDefault": true, "company": "Boyer Group", "street": "511 Hirthe Views Suite 229", "street2": "Suite 996", "city": "West Arnold", "stateProvince": "KY", "postcodeZip": "91911", "country": "USA" }, "method": "CARD" }, "customer": { "email": "test.customer@example.com", "firstName": "Elsie", "lastName": "Kautzer", "phone": "+18578674736", "dateOfBirth": "1975-08-07" }, "refundedAmount": 0, "refundableAmount": 70.05, "capturedAmount": 70.05, "remainingBalance": 0, "receiptUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85", "receiptPdfUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85/download", "dashboardUrl": "https://dashboard.prahsys.com/example-channel/merchants/example-merchant/orders/payment-c0ab7cf63263a85", "tags": [ "retail", "recurring" ] }, "availableBalance": { "amount": 3176.6, "currency": "USD" }, "requestedAmount": 663.16, "authorizationAdjustmentActions": "NO_ACTION", "authorizationAdjustmentAmount": 0, "authorizingEntity": "ISSUER", "authorizationCode": "PM16SU", "avsCode": "FULL_MATCH", "cscCode": "MATCH", "reference": "ref_av28no68", "stan": "369057", "source": "INTERNET", "terminal": "wem", "settlement": { "settlementDate": "2026-07-22T21:49:06+00:00", "settlementAmount": 663.16, "netAmount": 643.93, "totalFees": 19.23, "feeSettlementDate": "2026-07-22T21:49:06+00:00", "interchangeFee": 11.94, "networkFees": 1.33, "assessmentFee": 0.66, "payfacFee": 5.31, "chargebackFee": 0, "interchangeCode": "CPS-RETAIL", "settlingDate": "2026-07-21T21:49:06+00:00", "fundingStatus": "FUNDED", "onHold": false }, "refundedAmount": 0, "refundableAmount": 663.16, "createdAt": "2026-07-20T21:49:06.248+00:00" }, { "id": "6e5674b3-e836-3af0-8e5a-5c04597923ee", "targetTransactionId": "498ad608-83f8-307e-97c3-7a013c242c83", "operation": "CAPTURE", "type": "CAPTURE", "result": "SUCCESS", "settlementStatus": "SETTLED", "amount": 70.05, "currency": "USD", "payment": { "id": "payment-c0ab7cf63263a85", "merchantId": "Z70B874W63DW", "orderId": "order_az78bt57", "amount": 70.05, "currency": "USD", "description": "This is an example payment", "custom": { "merchantReference": "REF-1800-lmba" }, "type": "PRIMARY", "invoiceNumber": "b91a4e68-401a-327f-b804-e3aae625c677", "statementDescriptor": { "name": "Bins-Homenick", "phone": "209-814-4110", "websiteUrl": "http://sauer.com/vero-odio-nesciunt-quae-aut-sequi", "address": { "street": "133 Myrtle Pass", "city": "East Lucianochester", "stateProvince": "AR", "postcodeZip": "55443", "country": "USA" } }, "certainty": "FINAL", "status": "CAPTURED", "creationTime": "2026-01-18T18:48:18.000+00:00", "lastUpdatedTime": "2026-01-29T08:55:31.000+00:00", "result": "SUCCESS", "billing": { "card": { "nameOnCard": "John Doe", "number": "424242xxxxxx4242", "expiry": { "month": 1, "year": 39 }, "brand": "VISA", "fundingMethod": "DEBIT", "storedOnFile": "NOT_STORED" }, "address": { "id": "311c6267-d349-38d9-b5d0-77d29f5ca1e9", "isDefault": true, "company": "Boyer Group", "street": "511 Hirthe Views Suite 229", "street2": "Suite 996", "city": "West Arnold", "stateProvince": "KY", "postcodeZip": "91911", "country": "USA" }, "method": "CARD" }, "customer": { "email": "test.customer@example.com", "firstName": "Elsie", "lastName": "Kautzer", "phone": "+18578674736", "dateOfBirth": "1975-08-07" }, "refundedAmount": 0, "refundableAmount": 70.05, "capturedAmount": 70.05, "remainingBalance": 0, "receiptUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85", "receiptPdfUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85/download", "dashboardUrl": "https://dashboard.prahsys.com/example-channel/merchants/example-merchant/orders/payment-c0ab7cf63263a85", "tags": [ "retail", "recurring" ] }, "requestedAmount": 704.7, "authorizationAdjustmentActions": "NO_ACTION", "authorizationAdjustmentAmount": 0, "authorizingEntity": "ISSUER", "authorizationCode": "IM36BA", "avsCode": "FULL_MATCH", "cscCode": "MATCH", "reference": "ref_ph34kg36", "stan": "117683", "source": "INTERNET", "terminal": "fovpyhpzy", "settlement": { "settlementDate": "2026-07-22T22:37:06+00:00", "settlementAmount": 704.7, "netAmount": 684.26, "totalFees": 20.44, "feeSettlementDate": "2026-07-22T22:37:06+00:00", "interchangeFee": 12.68, "networkFees": 1.41, "assessmentFee": 0.7, "payfacFee": 5.64, "chargebackFee": 0, "interchangeCode": "CPS-RETAIL", "settlingDate": "2026-07-21T22:37:06+00:00", "fundingStatus": "FUNDED", "onHold": false }, "refundedAmount": 0, "refundableAmount": 704.7, "createdAt": "2026-07-20T22:37:06.251+00:00" } ] } }, "properties": { "success": { "type": "boolean", "example": true, "description": "Whether the request was successful", "enum": [] }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": "payment-c0ab7cf63263a85", "description": "Unique identifier for the payment", "enum": [] }, "merchantId": { "type": "string", "example": "Z70B874W63DW", "description": "Identifier for the merchant associated with the payment", "enum": [] }, "orderId": { "type": "string", "example": "order_az78bt57", "description": "Unique identifier for the order associated with the payment", "enum": [] }, "amount": { "type": "number", "example": 70.05, "description": "Total amount of the payment", "enum": [] }, "currency": { "type": "string", "example": "USD", "description": "Currency of the payment amount in ISO 4217 format", "enum": [] }, "description": { "type": "string", "example": "This is an example payment", "description": "Description of the payment", "enum": [] }, "custom": { "type": "object", "properties": { "merchantReference": { "type": "string", "example": "REF-1800-lmba" } }, "description": "Custom payment data specific to the merchant" }, "type": { "type": "string", "example": "PRIMARY", "description": "Type of payment (PRIMARY, FEES, or ADDITIONAL_CHARGES)", "enum": [ "PRIMARY", "FEES", "ADDITIONAL_CHARGES" ] }, "invoiceNumber": { "type": "string", "example": "b91a4e68-401a-327f-b804-e3aae625c677", "description": "Invoice number associated with the payment", "enum": [] }, "certainty": { "type": "string", "example": "FINAL", "description": "payment certainty status", "enum": [ "ESTIMATED", "FINAL" ] }, "statementDescriptor": { "type": "object", "properties": { "name": { "type": "string", "example": "Bins-Homenick", "description": "Name that appears on customer card statements", "enum": [] }, "phone": { "type": "string", "example": "209-814-4110", "description": "Name that appears on customer card statements", "enum": [] }, "websiteUrl": { "type": "string", "example": "http://sauer.com/vero-odio-nesciunt-quae-aut-sequi", "description": "Name that appears on customer card statements", "enum": [] }, "address": { "type": "object", "properties": { "street": { "type": "string", "example": "133 Myrtle Pass", "description": "The first line of the address.", "enum": [] }, "city": { "type": "string", "example": "East Lucianochester", "description": "The city portion of the address.", "enum": [] }, "stateProvince": { "type": "string", "example": "AR", "description": "The state or province code of the address.", "enum": [] }, "postcodeZip": { "type": "string", "example": "55443", "description": "The post code or zip code of the address.", "enum": [] }, "country": { "type": "string", "example": "USA", "description": "The 3 letter ISO standard alpha country code of the address.", "enum": [] } }, "description": "Street address to appear on statements" } }, "description": "Statement descriptor information for card statements" }, "status": { "type": "string", "example": "CAPTURED", "description": "The current progress status of the payment through the payment process", "enum": [ "AUTHORIZED", "CAPTURED", "PARTIALLY_CAPTURED", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "DECLINED", "ABORTED", "FAILURE", "FAILED", "PENDING", "SUCCESS", "UNKNOWN", "VERIFIED", "SETTLING", "SETTLED", "DISPUTED", "CAPTURE_PENDING", "REFUND_PENDING" ] }, "creationTime": { "type": "string", "example": "2026-01-18T18:48:18.000+00:00", "description": "Time when the payment was created", "enum": [] }, "lastUpdatedTime": { "type": "string", "example": "2026-01-29T08:55:31.000+00:00", "description": "Time when the payment was last updated", "enum": [] }, "result": { "type": "string", "example": "SUCCESS", "description": "Result of the payment processing", "enum": [ "FAILURE", "PENDING", "SUCCESS", "DECLINED", "UNKNOWN", "ERROR" ] }, "billing": { "type": "object", "properties": { "card": { "type": "object", "properties": { "nameOnCard": { "type": "string", "example": "John Doe", "description": "Cardholder name as it appears on the card", "enum": [] }, "number": { "type": "string", "example": "424242xxxxxx4242", "description": "Card number", "enum": [] }, "expiry": { "type": "object", "properties": { "month": { "type": "integer", "example": 1, "description": "Expiration month (1-12)", "enum": [] }, "year": { "type": "integer", "example": 39, "description": "Expiration year (2-digit format)", "enum": [] } }, "description": "Card expiration details" }, "brand": { "type": "string", "example": "VISA", "description": "Card brand name (e.g., VISA, MASTERCARD)", "enum": [ "AMEX", "CHINA_UNIONPAY", "DINERS_CLUB", "DISCOVER", "JCB", "LOCAL_BRAND_ONLY", "MAESTRO", "MASTERCARD", "RUPAY", "UATP", "UNKNOWN", "VISA" ] }, "fundingMethod": { "type": "string", "example": "DEBIT", "description": "Method used to fund the card (e.g., CREDIT, DEBIT)", "enum": [ "CHARGE", "CREDIT", "DEBIT", "UNKNOWN" ] }, "storedOnFile": { "type": "string", "example": "NOT_STORED", "description": "Indicates if and how the card is stored on file", "enum": [ "NOT_STORED", "STORED", "TO_BE_STORED" ] } }, "description": "Card payment details when using direct card input" }, "address": { "type": "object", "properties": { "id": { "type": "string", "example": "311c6267-d349-38d9-b5d0-77d29f5ca1e9", "description": "Unique identifier for this address. Provide when referencing an existing address; omit to create a new one.", "enum": [] }, "isDefault": { "type": "boolean", "example": true, "description": "Whether this is the customer's default address.", "enum": [] }, "company": { "type": "string", "example": "Boyer Group", "description": "The name of the company associated with this address.", "enum": [] }, "street": { "type": "string", "example": "511 Hirthe Views Suite 229", "description": "The first line of the address.", "enum": [] }, "street2": { "type": "string", "example": "Suite 996", "description": "The second line of the address.", "enum": [] }, "city": { "type": "string", "example": "West Arnold", "description": "The city portion of the address.", "enum": [] }, "stateProvince": { "type": "string", "example": "KY", "description": "The state or province code of the address.", "enum": [] }, "postcodeZip": { "type": "string", "example": "91911", "description": "The post code or zip code of the address.", "enum": [] }, "country": { "type": "string", "example": "USA", "description": "The 3 letter ISO standard alpha country code of the address.", "enum": [] } }, "description": "Billing address. When present, the address will be verified with the payment method (AVS)." }, "method": { "type": "string", "example": "CARD", "description": "Payment method used for this transaction. Defaults to CARD if not specified.", "enum": [ "CARD", "CASH", "CHECK", "ACH" ] } }, "description": "Billing information for the transaction" }, "customer": { "type": "object", "properties": { "email": { "type": "string", "example": "test.customer@example.com", "description": "The email address of the customer. Must be longer than 3 characters and conform to RFC 2822.", "enum": [] }, "firstName": { "type": "string", "example": "Elsie", "description": "The customer's first name.", "enum": [] }, "lastName": { "type": "string", "example": "Kautzer", "description": "The customer's last name.", "enum": [] }, "phone": { "type": "string", "example": "+18578674736", "description": "The customer's phone number in E.164 format.", "enum": [] }, "dateOfBirth": { "type": "string", "example": "1975-08-07", "description": "The customer's date of birth. Must be in YYYY-MM-DD format.", "enum": [] } }, "description": "Customer information" }, "refundedAmount": { "type": "integer", "example": 0, "description": "Total amount that has been refunded for this payment", "enum": [] }, "refundableAmount": { "type": "number", "example": 70.05, "description": "Amount available for refund (total captured amount minus refunded amount, excluding voided transactions)", "enum": [] }, "receiptUrl": { "type": "string", "example": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85", "description": "URL to view the payment receipt", "enum": [] }, "receiptPdfUrl": { "type": "string", "example": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85/download", "description": "URL to download the payment receipt as PDF", "enum": [] }, "dashboardUrl": { "type": "string", "example": "https://dashboard.prahsys.com/example-channel/merchants/example-merchant/orders/payment-c0ab7cf63263a85", "description": "URL to view the payment in the merchant dashboard", "enum": [] }, "tags": { "type": "array", "example": [ "retail", "recurring" ], "description": "Tags associated with the payment", "enum": [], "items": { "type": "string" } }, "transactions": { "type": "array", "example": [ { "id": "e8025759-596a-3c8f-8cab-ad9e83a9f69f", "operation": "AUTHORIZE", "type": "AUTHORIZATION", "result": "SUCCESS", "settlementStatus": "SETTLED", "amount": 70.05, "currency": "USD", "payment": { "id": "payment-c0ab7cf63263a85", "merchantId": "Z70B874W63DW", "orderId": "order_az78bt57", "amount": 70.05, "currency": "USD", "description": "This is an example payment", "custom": { "merchantReference": "REF-1800-lmba" }, "type": "PRIMARY", "invoiceNumber": "b91a4e68-401a-327f-b804-e3aae625c677", "statementDescriptor": { "name": "Bins-Homenick", "phone": "209-814-4110", "websiteUrl": "http://sauer.com/vero-odio-nesciunt-quae-aut-sequi", "address": { "street": "133 Myrtle Pass", "city": "East Lucianochester", "stateProvince": "AR", "postcodeZip": "55443", "country": "USA" } }, "certainty": "FINAL", "status": "CAPTURED", "creationTime": "2026-01-18T18:48:18.000+00:00", "lastUpdatedTime": "2026-01-29T08:55:31.000+00:00", "result": "SUCCESS", "billing": { "card": { "nameOnCard": "John Doe", "number": "424242xxxxxx4242", "expiry": { "month": 1, "year": 39 }, "brand": "VISA", "fundingMethod": "DEBIT", "storedOnFile": "NOT_STORED" }, "address": { "id": "311c6267-d349-38d9-b5d0-77d29f5ca1e9", "isDefault": true, "company": "Boyer Group", "street": "511 Hirthe Views Suite 229", "street2": "Suite 996", "city": "West Arnold", "stateProvince": "KY", "postcodeZip": "91911", "country": "USA" }, "method": "CARD" }, "customer": { "email": "test.customer@example.com", "firstName": "Elsie", "lastName": "Kautzer", "phone": "+18578674736", "dateOfBirth": "1975-08-07" }, "refundedAmount": 0, "refundableAmount": 70.05, "capturedAmount": 70.05, "remainingBalance": 0, "receiptUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85", "receiptPdfUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85/download", "dashboardUrl": "https://dashboard.prahsys.com/example-channel/merchants/example-merchant/orders/payment-c0ab7cf63263a85", "tags": [ "retail", "recurring" ] }, "availableBalance": { "amount": 3176.6, "currency": "USD" }, "requestedAmount": 663.16, "authorizationAdjustmentActions": "NO_ACTION", "authorizationAdjustmentAmount": 0, "authorizingEntity": "ISSUER", "authorizationCode": "PM16SU", "avsCode": "FULL_MATCH", "cscCode": "MATCH", "reference": "ref_av28no68", "stan": "369057", "source": "INTERNET", "terminal": "wem", "settlement": { "settlementDate": "2026-07-22T21:49:06+00:00", "settlementAmount": 663.16, "netAmount": 643.93, "totalFees": 19.23, "feeSettlementDate": "2026-07-22T21:49:06+00:00", "interchangeFee": 11.94, "networkFees": 1.33, "assessmentFee": 0.66, "payfacFee": 5.31, "chargebackFee": 0, "interchangeCode": "CPS-RETAIL", "settlingDate": "2026-07-21T21:49:06+00:00", "fundingStatus": "FUNDED", "onHold": false }, "refundedAmount": 0, "refundableAmount": 663.16, "createdAt": "2026-07-20T21:49:06.248+00:00" }, { "id": "6e5674b3-e836-3af0-8e5a-5c04597923ee", "targetTransactionId": "498ad608-83f8-307e-97c3-7a013c242c83", "operation": "CAPTURE", "type": "CAPTURE", "result": "SUCCESS", "settlementStatus": "SETTLED", "amount": 70.05, "currency": "USD", "payment": { "id": "payment-c0ab7cf63263a85", "merchantId": "Z70B874W63DW", "orderId": "order_az78bt57", "amount": 70.05, "currency": "USD", "description": "This is an example payment", "custom": { "merchantReference": "REF-1800-lmba" }, "type": "PRIMARY", "invoiceNumber": "b91a4e68-401a-327f-b804-e3aae625c677", "statementDescriptor": { "name": "Bins-Homenick", "phone": "209-814-4110", "websiteUrl": "http://sauer.com/vero-odio-nesciunt-quae-aut-sequi", "address": { "street": "133 Myrtle Pass", "city": "East Lucianochester", "stateProvince": "AR", "postcodeZip": "55443", "country": "USA" } }, "certainty": "FINAL", "status": "CAPTURED", "creationTime": "2026-01-18T18:48:18.000+00:00", "lastUpdatedTime": "2026-01-29T08:55:31.000+00:00", "result": "SUCCESS", "billing": { "card": { "nameOnCard": "John Doe", "number": "424242xxxxxx4242", "expiry": { "month": 1, "year": 39 }, "brand": "VISA", "fundingMethod": "DEBIT", "storedOnFile": "NOT_STORED" }, "address": { "id": "311c6267-d349-38d9-b5d0-77d29f5ca1e9", "isDefault": true, "company": "Boyer Group", "street": "511 Hirthe Views Suite 229", "street2": "Suite 996", "city": "West Arnold", "stateProvince": "KY", "postcodeZip": "91911", "country": "USA" }, "method": "CARD" }, "customer": { "email": "test.customer@example.com", "firstName": "Elsie", "lastName": "Kautzer", "phone": "+18578674736", "dateOfBirth": "1975-08-07" }, "refundedAmount": 0, "refundableAmount": 70.05, "capturedAmount": 70.05, "remainingBalance": 0, "receiptUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85", "receiptPdfUrl": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85/download", "dashboardUrl": "https://dashboard.prahsys.com/example-channel/merchants/example-merchant/orders/payment-c0ab7cf63263a85", "tags": [ "retail", "recurring" ] }, "requestedAmount": 704.7, "authorizationAdjustmentActions": "NO_ACTION", "authorizationAdjustmentAmount": 0, "authorizingEntity": "ISSUER", "authorizationCode": "IM36BA", "avsCode": "FULL_MATCH", "cscCode": "MATCH", "reference": "ref_ph34kg36", "stan": "117683", "source": "INTERNET", "terminal": "fovpyhpzy", "settlement": { "settlementDate": "2026-07-22T22:37:06+00:00", "settlementAmount": 704.7, "netAmount": 684.26, "totalFees": 20.44, "feeSettlementDate": "2026-07-22T22:37:06+00:00", "interchangeFee": 12.68, "networkFees": 1.41, "assessmentFee": 0.7, "payfacFee": 5.64, "chargebackFee": 0, "interchangeCode": "CPS-RETAIL", "settlingDate": "2026-07-21T22:37:06+00:00", "fundingStatus": "FUNDED", "onHold": false }, "refundedAmount": 0, "refundableAmount": 704.7, "createdAt": "2026-07-20T22:37:06.251+00:00" } ], "description": "List of transactions associated with this payment", "enum": [], "items": { "type": "object", "properties": { "id": { "type": "string", "example": "e8025759-596a-3c8f-8cab-ad9e83a9f69f", "description": "Unique reference that identifies this specific transaction", "enum": [] }, "operation": { "type": "string", "example": "AUTHORIZE", "description": "Specifies the requested API operation", "enum": [ "AUTHORIZE", "CAPTURE", "CHARGEBACK", "PAY", "REFUND", "VERIFY", "VOID", "ADJUSTMENT", "UPDATE_AUTHORIZATION", "CHARGEBACK_REVERSAL" ] }, "type": { "type": "string", "example": "AUTHORIZATION", "description": "Specifies the transaction type which was executed", "enum": [ "AUTHENTICATION", "AUTHORIZATION", "AUTHORIZATION_UPDATE", "CAPTURE", "CHARGEBACK", "DISBURSEMENT", "FUNDING", "REFUND", "REFUND_REQUEST", "VERIFICATION", "VOID_AUTHORIZATION", "VOID_CAPTURE", "VOID_REFUND", "ADJUSTMENT", "ADJUSTMENT_FROM", "ADJUSTMENT_TO", "CHARGEBACK_REVERSAL" ] }, "result": { "type": "string", "example": "SUCCESS", "description": "Result of the transaction", "enum": [ "FAILURE", "PENDING", "SUCCESS", "DECLINED", "UNKNOWN", "ERROR" ] }, "settlementStatus": { "type": "string", "example": "SETTLED", "description": "Transaction settlement status (pending, settled, deposited)", "enum": [ "PENDING", "SETTLING", "SETTLED", "ON_HOLD" ] }, "amount": { "type": "number", "example": 70.05, "description": "Total financial value of the transaction", "enum": [] }, "currency": { "type": "string", "example": "USD", "description": "Three-letter ISO currency code for the transaction", "enum": [] }, "payment": { "type": "object", "properties": { "id": { "type": "string", "example": "payment-c0ab7cf63263a85", "description": "Unique identifier for the payment", "enum": [] }, "merchantId": { "type": "string", "example": "Z70B874W63DW", "description": "Identifier for the merchant associated with the payment", "enum": [] }, "orderId": { "type": "string", "example": "order_az78bt57", "description": "Unique identifier for the order associated with the payment", "enum": [] }, "amount": { "type": "number", "example": 70.05, "description": "Total amount of the payment", "enum": [] }, "currency": { "type": "string", "example": "USD", "description": "Currency of the payment amount in ISO 4217 format", "enum": [] }, "description": { "type": "string", "example": "This is an example payment", "description": "Description of the payment", "enum": [] }, "custom": { "type": "object", "properties": { "merchantReference": { "type": "string", "example": "REF-1800-lmba" } }, "description": "Custom payment data specific to the merchant" }, "type": { "type": "string", "example": "PRIMARY", "description": "Type of payment (PRIMARY, FEES, or ADDITIONAL_CHARGES)", "enum": [ "PRIMARY", "FEES", "ADDITIONAL_CHARGES" ] }, "invoiceNumber": { "type": "string", "example": "b91a4e68-401a-327f-b804-e3aae625c677", "description": "Invoice number associated with the payment", "enum": [] }, "statementDescriptor": { "type": "object", "properties": { "name": { "type": "string", "example": "Bins-Homenick", "description": "Name that appears on customer card statements", "enum": [] }, "phone": { "type": "string", "example": "209-814-4110", "description": "Name that appears on customer card statements", "enum": [] }, "websiteUrl": { "type": "string", "example": "http://sauer.com/vero-odio-nesciunt-quae-aut-sequi", "description": "Name that appears on customer card statements", "enum": [] }, "address": { "type": "object", "properties": { "street": { "type": "string", "example": "133 Myrtle Pass", "description": "The first line of the address.", "enum": [] }, "city": { "type": "string", "example": "East Lucianochester", "description": "The city portion of the address.", "enum": [] }, "stateProvince": { "type": "string", "example": "AR", "description": "The state or province code of the address.", "enum": [] }, "postcodeZip": { "type": "string", "example": "55443", "description": "The post code or zip code of the address.", "enum": [] }, "country": { "type": "string", "example": "USA", "description": "The 3 letter ISO standard alpha country code of the address.", "enum": [] } }, "description": "Street address to appear on statements" } }, "description": "Statement descriptor information for card statements" }, "certainty": { "type": "string", "example": "FINAL", "description": "Payment certainty status", "enum": [ "ESTIMATED", "FINAL" ] }, "status": { "type": "string", "example": "CAPTURED", "description": "The current progress status of the payment through the payment process", "enum": [ "AUTHORIZED", "CAPTURED", "PARTIALLY_CAPTURED", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "DECLINED", "ABORTED", "FAILURE", "FAILED", "PENDING", "SUCCESS", "UNKNOWN", "VERIFIED", "SETTLING", "SETTLED", "DISPUTED", "CAPTURE_PENDING", "REFUND_PENDING" ] }, "creationTime": { "type": "string", "example": "2026-01-18T18:48:18.000+00:00", "description": "Time when the payment was created", "enum": [] }, "lastUpdatedTime": { "type": "string", "example": "2026-01-29T08:55:31.000+00:00", "description": "Time when the payment was last updated", "enum": [] }, "result": { "type": "string", "example": "SUCCESS", "description": "Result of the payment processing", "enum": [ "FAILURE", "PENDING", "SUCCESS", "DECLINED", "UNKNOWN", "ERROR" ] }, "billing": { "type": "object", "properties": { "card": { "type": "object", "properties": { "nameOnCard": { "type": "string", "example": "John Doe", "description": "Cardholder name as it appears on the card", "enum": [] }, "number": { "type": "string", "example": "424242xxxxxx4242", "description": "Card number", "enum": [] }, "expiry": { "type": "object", "properties": { "month": { "type": "integer", "example": 1, "description": "Expiration month (1-12)", "enum": [] }, "year": { "type": "integer", "example": 39, "description": "Expiration year (2-digit format)", "enum": [] } }, "description": "Card expiration details" }, "brand": { "type": "string", "example": "VISA", "description": "Card brand name (e.g., VISA, MASTERCARD)", "enum": [ "AMEX", "CHINA_UNIONPAY", "DINERS_CLUB", "DISCOVER", "JCB", "LOCAL_BRAND_ONLY", "MAESTRO", "MASTERCARD", "RUPAY", "UATP", "UNKNOWN", "VISA" ] }, "fundingMethod": { "type": "string", "example": "DEBIT", "description": "Method used to fund the card (e.g., CREDIT, DEBIT)", "enum": [ "CHARGE", "CREDIT", "DEBIT", "UNKNOWN" ] }, "storedOnFile": { "type": "string", "example": "NOT_STORED", "description": "Indicates if and how the card is stored on file", "enum": [ "NOT_STORED", "STORED", "TO_BE_STORED" ] } }, "description": "Card payment details when using direct card input" }, "address": { "type": "object", "properties": { "id": { "type": "string", "example": "311c6267-d349-38d9-b5d0-77d29f5ca1e9", "description": "Unique identifier for this address. Provide when referencing an existing address; omit to create a new one.", "enum": [] }, "isDefault": { "type": "boolean", "example": true, "description": "Whether this is the customer's default address.", "enum": [] }, "company": { "type": "string", "example": "Boyer Group", "description": "The name of the company associated with this address.", "enum": [] }, "street": { "type": "string", "example": "511 Hirthe Views Suite 229", "description": "The first line of the address.", "enum": [] }, "street2": { "type": "string", "example": "Suite 996", "description": "The second line of the address.", "enum": [] }, "city": { "type": "string", "example": "West Arnold", "description": "The city portion of the address.", "enum": [] }, "stateProvince": { "type": "string", "example": "KY", "description": "The state or province code of the address.", "enum": [] }, "postcodeZip": { "type": "string", "example": "91911", "description": "The post code or zip code of the address.", "enum": [] }, "country": { "type": "string", "example": "USA", "description": "The 3 letter ISO standard alpha country code of the address.", "enum": [] } }, "description": "Billing address. When present, the address will be verified with the payment method (AVS)." }, "method": { "type": "string", "example": "CARD", "description": "Payment method used for this transaction. Defaults to CARD if not specified.", "enum": [ "CARD", "CASH", "CHECK", "ACH" ] } }, "description": "Billing information for the transaction" }, "customer": { "type": "object", "properties": { "email": { "type": "string", "example": "test.customer@example.com", "description": "The email address of the customer. Must be longer than 3 characters and conform to RFC 2822.", "enum": [] }, "firstName": { "type": "string", "example": "Elsie", "description": "The customer's first name.", "enum": [] }, "lastName": { "type": "string", "example": "Kautzer", "description": "The customer's last name.", "enum": [] }, "phone": { "type": "string", "example": "+18578674736", "description": "The customer's phone number in E.164 format.", "enum": [] }, "dateOfBirth": { "type": "string", "example": "1975-08-07", "description": "The customer's date of birth. Must be in YYYY-MM-DD format.", "enum": [] } }, "description": "Customer information" }, "refundedAmount": { "type": "integer", "example": 0, "description": "Total amount that has been refunded for this payment", "enum": [] }, "refundableAmount": { "type": "number", "example": 70.05, "description": "Amount available for refund (total captured amount minus refunded amount, excluding voided transactions)", "enum": [] }, "capturedAmount": { "type": "number", "example": 70.05, "description": "Total amount that has been captured for this payment", "enum": [] }, "remainingBalance": { "type": "integer", "example": 0, "description": "Remaining balance available for capture (payment amount minus captured amount)", "enum": [] }, "receiptUrl": { "type": "string", "example": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85", "description": "URL to view the payment receipt", "enum": [] }, "receiptPdfUrl": { "type": "string", "example": "https://api.prahsys.com/receipt/payment-c0ab7cf63263a85/download", "description": "URL to download the payment receipt as PDF", "enum": [] }, "dashboardUrl": { "type": "string", "example": "https://dashboard.prahsys.com/example-channel/merchants/example-merchant/orders/payment-c0ab7cf63263a85", "description": "URL to view the payment in the merchant dashboard", "enum": [] }, "tags": { "type": "array", "example": [ "retail", "recurring" ], "description": "Tags associated with the payment", "enum": [], "items": { "type": "string" } } }, "description": "Payment details at the time of the transaction" }, "availableBalance": { "type": "object", "properties": { "amount": { "type": "number", "example": 3176.6, "description": "Represents the spendable amount remaining on the card after transaction", "enum": [] }, "currency": { "type": "string", "example": "USD", "description": "ISO 4217 currency code representing the balance currency", "enum": [] } }, "description": "Available balance on the card" }, "requestedAmount": { "type": "number", "example": 663.16, "description": "Initial amount requested for the transaction.", "enum": [] }, "authorizationAdjustmentActions": { "type": "string", "example": "NO_ACTION", "description": "Specifies how to handle authorization amount adjustments for card-based gateways. Must be one of: INCREMENT (increase the authorization amount to match the capture amount), NO_ACTION (do not change the authorization amount). Null for non-card gateways (e.g., cash payments).", "enum": [] }, "authorizationAdjustmentAmount": { "type": "integer", "example": 0, "description": "Value by which the initial authorization was modified", "enum": [] }, "authorizingEntity": { "type": "string", "example": "ISSUER", "description": "Entity that made the authorization decision. Must be one of: ACQUIRER (acquirer made decision), ISSUER (issuer made decision), or SCHEME (scheme made decision)", "enum": [] }, "authorizationCode": { "type": "string", "example": "PM16SU", "description": "Bank-generated code responding to transfer proposal", "enum": [] }, "avsCode": { "type": "string", "example": "FULL_MATCH", "description": "AVS (Address Verification System) result indicating whether billing address matched", "enum": [ "FULL_MATCH", "PARTIAL_ADDRESS_MATCH", "PARTIAL_POSTAL_MATCH", "PARTIAL_NAME_MATCH", "NO_MATCH", "SERVICE_UNAVAILABLE", "NOT_SUPPORTED", "NOT_VERIFIED" ] }, "cscCode": { "type": "string", "example": "MATCH", "description": "CSC (Card Security Code) verification result returned by the payment gateway", "enum": [] }, "reference": { "type": "string", "example": "ref_av28no68", "description": "Optional identifier for the transaction", "enum": [] }, "stan": { "type": "string", "example": "369057", "description": "System Trace Audit Number (STAN), which is assigned by the gateway and used for transaction message identification", "enum": [] }, "source": { "type": "string", "example": "INTERNET", "description": "Indicates how the transaction was initiated", "enum": [ "ACH", "CARD_PRESENT", "INTERNET", "MAIL_ORDER", "MERCHANT", "MOTO", "PAYER_PRESENT", "SERVICE_PROVIDER", "TELEPHONE_ORDER", "VOICE_RESPONSE" ] }, "terminal": { "type": "string", "example": "wem", "description": "Terminal used by the processor/acquirer", "enum": [] }, "settlement": { "type": "object", "properties": { "settlementDate": { "type": "string", "example": "2026-07-22T21:49:06+00:00", "description": "Date when transaction is fully settled (final state)", "enum": [] }, "settlementAmount": { "type": "number", "example": 663.16, "description": "Total settlement amount", "enum": [] }, "netAmount": { "type": "number", "example": 643.93, "description": "Net amount after fees", "enum": [] }, "totalFees": { "type": "number", "example": 19.23, "description": "Total fees charged", "enum": [] }, "feeSettlementDate": { "type": "string", "example": "2026-07-22T21:49:06+00:00", "description": "Fee settlement date", "enum": [] }, "interchangeFee": { "type": "number", "example": 11.94, "description": "Interchange fee", "enum": [] }, "networkFees": { "type": "number", "example": 1.33, "description": "Network fees", "enum": [] }, "assessmentFee": { "type": "number", "example": 0.66, "description": "Assessment fee", "enum": [] }, "payfacFee": { "type": "number", "example": 5.31, "description": "Payfac fee charged to merchant", "enum": [] }, "chargebackFee": { "type": "integer", "example": 0, "description": "Chargeback fee charged to submerchant", "enum": [] }, "interchangeCode": { "type": "string", "example": "CPS-RETAIL", "description": "Interchange code", "enum": [] }, "settlingDate": { "type": "string", "example": "2026-07-21T21:49:06+00:00", "description": "Date when the transaction is settling (intermediate state)", "enum": [] }, "fundingStatus": { "type": "string", "example": "FUNDED", "description": "Funding status", "enum": [ "PENDING", "FUNDED", "FAILED" ] }, "onHold": { "type": "boolean", "example": false, "description": "Whether the transaction is on hold", "enum": [] } }, "description": "Transaction settlement details" }, "refundedAmount": { "type": "integer", "example": 0, "description": "Total amount that has been refunded for this transaction", "enum": [] }, "refundableAmount": { "type": "number", "example": 663.16, "description": "Amount available for refund on this transaction", "enum": [] }, "createdAt": { "type": "string", "example": "2026-07-20T21:49:06.248+00:00", "description": "Time when the transaction was created", "enum": [] } } } } }, "description": "The data returned from the request" } } } } } }, "400": { "description": "Validation error response (Validation Error Example)", "content": { "application/json": { "schema": { "type": "object", "example": { "success": false, "message": "The field1 is required (and one other error)", "errors": { "field1": [ "The field1 is required." ], "field2": [ "The field2 must be a valid value." ] } }, "properties": { "success": { "type": "boolean", "example": false, "description": "Whether the request was successful", "enum": [] }, "message": { "type": "string", "example": "The field1 is required (and one other error)", "description": "A message describing the result of the request", "enum": [] }, "errors": { "type": "object", "properties": { "field1": { "type": "array", "example": [ "The field1 is required." ], "items": { "type": "string" } }, "field2": { "type": "array", "example": [ "The field2 must be a valid value." ], "items": { "type": "string" } } }, "description": "Any errors that occurred during the request" } } } } } }, "401": { "description": "Authorization error response (Unauthorized Example)", "content": { "application/json": { "schema": { "type": "object", "example": { "success": false, "message": "Authentication is required" }, "properties": { "success": { "type": "boolean", "example": false, "description": "Whether the request was successful", "enum": [] }, "message": { "type": "string", "example": "Authentication is required", "description": "A message describing the result of the request", "enum": [] } } } } } }, "500": { "description": "Error response (Server Error Example)", "content": { "application/json": { "schema": { "type": "object", "example": { "success": false, "message": "Internal Server Error" }, "properties": { "success": { "type": "boolean", "example": false, "description": "Whether the request was successful", "enum": [] }, "message": { "type": "string", "example": "Internal Server Error", "description": "A message describing the result of the request", "enum": [] } } } } } } }, "tags": [ "Payments" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the payment", "example": "payment-4b7b7f3bb15ef9f", "nullable": true }, "merchantId": { "type": "string", "description": "Identifier for the merchant associated with the payment", "example": null, "nullable": true }, "orderId": { "type": "string", "description": "Unique identifier for the order associated with the payment", "example": null, "nullable": true }, "amount": { "type": "number", "description": "Total amount of the payment", "example": 4.14, "nullable": false }, "cashAmount": { "type": "number", "description": "The cash amount provided by the customer. When provided, the amount field is automatically calculated by applying the merchant's cash discount rate. Cannot be provided together with amount — provide only one.", "example": null, "nullable": true }, "currency": { "type": "string", "description": "Currency of the payment amount in ISO 4217 format", "example": "USD", "nullable": false }, "description": { "type": "string", "description": "Description of the payment", "example": "This is an example payment", "nullable": true }, "custom": { "type": "array", "description": "Custom payment data specific to the merchant", "example": null, "items": { "type": "string", "nullable": true } }, "type": { "type": "string", "description": "Type of payment (PRIMARY, FEES, or ADDITIONAL_CHARGES)", "example": null, "nullable": true, "enum": [ "PRIMARY", "FEES", "ADDITIONAL_CHARGES" ] }, "invoiceNumber": { "type": "string", "description": "Invoice number associated with the payment", "example": null, "nullable": true }, "certainty": { "type": "string", "description": "payment certainty status", "example": null, "nullable": true, "enum": [ "ESTIMATED", "FINAL" ] }, "statementDescriptor": { "type": "object", "description": "Statement descriptor information for card statements", "example": null, "nullable": true, "properties": { "name": { "type": "string", "description": "Name that appears on customer card statements", "example": null, "nullable": false }, "phone": { "type": "string", "description": "Name that appears on customer card statements", "example": null, "nullable": false }, "websiteUrl": { "type": "string", "description": "Name that appears on customer card statements", "example": null, "nullable": false }, "address": { "type": "object", "description": "Street address to appear on statements", "example": null, "nullable": true, "properties": { "id": { "type": "string", "description": "Unique identifier for this address. Provide when referencing an existing address; omit to create a new one.", "example": null, "nullable": true }, "company": { "type": "string", "description": "The name of the company associated with this address.", "example": null, "nullable": true }, "street": { "type": "string", "description": "The first line of the address.", "example": null, "nullable": true }, "street2": { "type": "string", "description": "The second line of the address.", "example": null, "nullable": true }, "city": { "type": "string", "description": "The city portion of the address.", "example": null, "nullable": true }, "stateProvince": { "type": "string", "description": "The state or province code of the address.", "example": null, "nullable": true }, "postcodeZip": { "type": "string", "description": "The post code or zip code of the address.", "example": null, "nullable": true }, "country": { "type": "string", "description": "The 3 letter ISO standard alpha country code of the address.", "example": null, "nullable": true } } } } }, "billing": { "type": "object", "description": "Billing information for the transaction", "example": null, "nullable": true, "properties": { "card": { "type": "object", "description": "Card payment details when using direct card input", "example": null, "nullable": true, "properties": { "nameOnCard": { "type": "string", "description": "Cardholder name as it appears on the card", "example": null, "nullable": true }, "number": { "type": "string", "description": "Card number", "example": null, "nullable": true }, "numberMasked": { "type": "string", "description": "Masked Card number (e.g., \"xxxxxxxxxxxx0008\")", "example": null, "nullable": true }, "expiry": { "type": "object", "description": "Card expiration details", "example": null, "nullable": true, "properties": { "month": { "type": "integer", "description": "Expiration month (1-12)", "example": null, "nullable": true }, "year": { "type": "integer", "description": "Expiration year (2-digit format)", "example": null, "nullable": true } } }, "securityCode": { "type": "string", "description": "Card security code (CVV/CVC)", "example": null, "nullable": true }, "brand": { "type": "string", "description": "Card brand name (e.g., VISA, MASTERCARD)", "example": null, "nullable": true, "enum": [ "AMEX", "CHINA_UNIONPAY", "DINERS_CLUB", "DISCOVER", "JCB", "LOCAL_BRAND_ONLY", "MAESTRO", "MASTERCARD", "RUPAY", "UATP", "UNKNOWN", "VISA" ] }, "fundingMethod": { "type": "string", "description": "Method used to fund the card (e.g., CREDIT, DEBIT)", "example": null, "nullable": true, "enum": [ "CHARGE", "CREDIT", "DEBIT", "UNKNOWN" ] }, "storedOnFile": { "type": "string", "description": "Indicates if and how the card is stored on file", "example": null, "nullable": true, "enum": [ "NOT_STORED", "STORED", "TO_BE_STORED" ] } } }, "bankAccount": { "type": "object", "description": "Bank account details when using direct ACH input (e.g. during session tokenization)", "example": null, "nullable": true, "properties": { "accountNumber": { "type": "string", "description": "Full account number; only present at tokenization time, never returned after", "example": null, "nullable": true }, "routingNumber": { "type": "string", "description": "9-digit ABA routing number", "example": null, "nullable": true }, "accountHolderName": { "type": "string", "description": "Name of the account holder", "example": null, "nullable": true }, "accountType": { "type": "string", "description": "Type of bank account", "example": null, "nullable": true } } }, "token": { "type": "string", "description": "Token value when using tokenized payment methods", "example": null, "nullable": true }, "address": { "type": "object", "description": "Billing address. When present, the address will be verified with the payment method (AVS).", "example": null, "nullable": true, "properties": { "id": { "type": "string", "description": "Unique identifier for this address. Provide when referencing an existing address; omit to create a new one.", "example": null, "nullable": true }, "company": { "type": "string", "description": "The name of the company associated with this address.", "example": null, "nullable": true }, "street": { "type": "string", "description": "The first line of the address.", "example": null, "nullable": true }, "street2": { "type": "string", "description": "The second line of the address.", "example": null, "nullable": true }, "city": { "type": "string", "description": "The city portion of the address.", "example": null, "nullable": true }, "stateProvince": { "type": "string", "description": "The state or province code of the address.", "example": null, "nullable": true }, "postcodeZip": { "type": "string", "description": "The post code or zip code of the address.", "example": null, "nullable": true }, "country": { "type": "string", "description": "The 3 letter ISO standard alpha country code of the address.", "example": null, "nullable": true } } }, "method": { "type": "string", "description": "Payment method used for this transaction. Defaults to CARD if not specified.", "example": null, "nullable": true, "enum": [ "CARD", "CASH", "CHECK", "ACH" ] } } }, "customer": { "type": "object", "description": "Customer information", "example": null, "nullable": true, "properties": { "id": { "type": "string", "description": "Prahsys's unique identifier for the customer", "example": null, "nullable": true }, "email": { "type": "string", "description": "The email address of the customer. Must be longer than 3 characters and conform to RFC 2822.", "example": null, "nullable": true }, "firstName": { "type": "string", "description": "The customer's first name.", "example": null, "nullable": true }, "lastName": { "type": "string", "description": "The customer's last name.", "example": null, "nullable": true }, "phone": { "type": "string", "description": "The customer's phone number in E.164 format.", "example": null, "nullable": true }, "dateOfBirth": { "type": "string", "description": "The customer's date of birth. Must be in YYYY-MM-DD format.", "example": "1985-06-26", "nullable": true } } } } } } } } }, "parameters": [ { "in": "path", "name": "merchantId", "description": "The merchant ID", "example": "Z70B874W63DW", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "paymentId", "description": "(optional) string identifier for the payment with max of 40 character. If not provided, one will be auto-generated", "example": "PAYMENT-Z70B874W63DW-123456", "required": true, "schema": { "type": "string" } } ] } } } ```