{"openapi":"3.1.0","servers":[{"url":"https://api.centrobill.com","description":"LIVE endpoint"},{"url":"https://stage.api.centrobill.com","description":"STAGE endpoint"}],"info":{"description":"Centrobill API\n\n The HTTP headers are used to pass additional information between the clients and the server through the request and response header.\nCertain request customization requires setting HTTP headers.\n`Content-Type` and `Accept` headers control input and output format.","version":"1.8.1","title":"Centrobill Payment API"},"security":[{"ApiKeyAuth":[]}],"x-tagGroups":[{"name":"Server-to-server","tags":["Payment","Payout","Subscription","Site","Product","Consumer","Test payment data","Service","Verification","Currency exchange rates"]},{"name":"Hosted payment page","tags":["Hosted payment page"]}],"paths":{"/tokenize":{"post":{"tags":["Payment"],"summary":"Tokenization","operationId":"generateCardDataToken","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload of tokenize","properties":{"number":{"title":"Card number","description":"Full card number","type":"string","minLength":12,"maxLength":19},"expirationYear":{"title":"Card expiration year","description":"The expiry year of the card","type":"string","minLength":2,"maxLength":2},"expirationMonth":{"title":"Card expiration month","description":"The expiry month of the card","type":"string","minLength":2,"maxLength":2},"cvv":{"title":"Card security code","type":"string","description":"The final three digits printed on the back of the card","minLength":3,"maxLength":4},"cardHolder":{"title":"Cardholder full name","description":"The cardholder full name","type":"string","minLength":1,"maxLength":64,"example":"John Smith"},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["number","expirationYear","expirationMonth"],"example":{"number":"4024007179366348","expirationYear":"25","expirationMonth":"12","cvv":"009","cardHolder":"John Smith","zip":"14000"}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent tokenize result","type":"object","properties":{"token":{"title":"Token for payment details","description":"A unique one-time token that stores sensitive payment details","type":"string","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"expireAt":{"type":"integer","title":"Unixtimestamp when token expires","description":"Token expiration date. The token is valid for 30 minutes from the moment of its creation","example":1611735028}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/tokenizeWithPaymentAccountId":{"post":{"tags":["Payment"],"summary":"Tokenization using payment account & consumer IDs","operationId":"generateCardDataTokenUsingPaymentAccountId","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload of tokenize","properties":{"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid"},"consumerId":{"type":"string","description":"Gateway consumer ID (user ID)","minLength":5,"maxLength":36},"cvv":{"title":"Card security code","type":"string","description":"The final three digits printed on the back of the card","minLength":3,"maxLength":4}},"required":["paymentAccountId","consumerId","cvv"],"example":{"paymentAccount":"03a470ee-6fb8-4e46-8d7c-b47f345cd09a","consumerId":"12345678","cvv":"009"}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent tokenize result","type":"object","properties":{"token":{"title":"Token for payment details","description":"A unique one-time token that stores sensitive payment details","type":"string","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"expireAt":{"type":"integer","title":"Unixtimestamp when token expires","description":"Token expiration date. The token is valid for 30 minutes from the moment of its creation","example":1611735028}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/payment":{"post":{"tags":["Payment"],"summary":"Server-to-server","operationId":"pay","description":"","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload to create payment","type":"object","properties":{"paymentSource":{"oneOf":[{"title":"Credit card","type":"object","required":["type","number","expirationYear","expirationMonth","cvv"],"properties":{"type":{"enum":["card"]},"number":{"title":"Card number","description":"Full card number","type":"string","minLength":12,"maxLength":19},"expirationYear":{"title":"Card expiration year","description":"The expiry year of the card","type":"string","minLength":2,"maxLength":2},"expirationMonth":{"title":"Card expiration month","description":"The expiry month of the card","type":"string","minLength":2,"maxLength":2},"cvv":{"type":"string","title":"Card security code","description":"The final three digits printed on the back of the card","minLength":3,"maxLength":4},"3ds":{"type":"boolean","title":"Payment should be processed with 3D Secure. True by default","description":"Activate the 3DS or SCA authentication process for this transaction. Set to <b>true</b> by default"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36},"mpiParameters":{"properties":{"authStatus":{"title":"authStatus","type":"string","description":"Authorization status","example":"Y"},"cavv":{"title":"cavv","type":"string","description":"CAVV value","example":"kBMSV/fB8ausrgK8Xem8wIQBeP88"},"eci":{"title":"eci","type":"string","description":"ECI value","example":"02"},"protocolVersion":{"title":"protocolVersion","type":"string","description":"Version of Protocol","example":2},"directoryServerTransactionId":{"title":"directoryServerTransactionId","type":"string","description":"Directory Server Transaction ID","example":"3ba1f2c9-613b-4c00-80b1-ec8869690b26"},"scaExemption":{"title":"scaExemption","description":"SCA exemption","enum":["lowValue","tra","merchantWhitelist","recurringTransaction","trustedBeneficiary","moto"],"example":"lowValue"}}}}},{"title":"Sepa","type":"object","required":["type","iban"],"properties":{"type":{"enum":["sepa"]},"iban":{"type":"string","minLength":5,"maxLength":34,"description":"International bank account number in ISO-13616 format","title":"International bank account number ISO-13616"},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Sofortbanking","type":"object","required":["type"],"properties":{"type":{"enum":["sofortbanking"]},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Onlinebanking","type":"object","required":["type"],"properties":{"type":{"enum":["onlinebanking"]},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36},"bin":{"title":"Bank Identification Number","description":"First 6 to 8 digits on the bank card","type":"integer","minLength":100000,"maxLength":99999999},"bankId":{"title":"Id of the Bank","description":"ID of the specific bank which user should be routed","type":"string","example":"revolut_eu"}}},{"title":"Paysafecard","type":"object","required":["type"],"properties":{"type":{"enum":["paysafecard"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}},{"title":"Giropay","type":"object","required":["type"],"properties":{"type":{"enum":["giropay"]},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Ideal","type":"object","required":["type"],"properties":{"type":{"enum":["ideal"]},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"PPS","type":"object","required":["type"],"properties":{"type":{"enum":["pps"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Gash","type":"object","required":["type"],"properties":{"type":{"enum":["gash"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Przelewy24","type":"object","required":["type"],"properties":{"type":{"enum":["przelewy24"]},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Bancontact","type":"object","required":["type"],"properties":{"type":{"enum":["bancontact"]},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Eps","type":"object","required":["type"],"properties":{"type":{"enum":["eps"]},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Mybank","type":"object","required":["type"],"properties":{"type":{"enum":["mybank"]},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Consumer saved payment data","type":"object","required":["type","value"],"properties":{"type":{"enum":["consumer"]},"value":{"type":"string","description":"Gateway consumer ID. The value you received in the IPN after the initial transaction","minLength":5,"maxLength":36},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}},{"title":"Concrete payment account of customer with CVV number","type":"object","required":["type","paymentAccountId","cvv"],"properties":{"type":{"enum":["paymentAccountIdWithCvv"]},"paymentAccountId":{"type":"string","format":"uuid","description":"ID of the encoded user payment details","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"cvv":{"type":"string","minLength":3,"maxLength":4,"title":"Card secure code"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}},{"title":"Concrete payment account of customer","type":"object","required":["type","paymentAccountId"],"properties":{"type":{"enum":["paymentAccountId"]},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}},{"title":"Token of tokenized card data","type":"object","required":["type","value"],"properties":{"type":{"enum":["token"]},"value":{"type":"string","description":"Token you have received after using <b>../tokenize</b> or <b>../tokenizeWithPaymentAccountId</b>","minLength":5,"maxLength":36},"3ds":{"type":"boolean","title":"Payment should be processed with 3D Secure. Set to <b>true</b> by default","description":"Activate the 3DS or SCA authentication process for this transaction. Set to <b>true</b> by default"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}},{"title":"Crypto","type":"object","required":["type"],"properties":{"type":{"enum":["crypto"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}},{"title":"X1","type":"object","required":["type"],"properties":{"type":{"enum":["x1"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}},{"title":"PayID","type":"object","required":["type"],"properties":{"type":{"enum":["payid"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"ACH","type":"object","required":["accountType","abaNumber","accountNumber","type"],"properties":{"type":{"enum":["ach"]},"accountType":{"title":"Account type","enum":["С","S"],"description":"Specify account type. C - for checking account, S - for savings account"},"abaNumber":{"title":"ABA number","type":"string","maxLength":32,"example":"122059ifs0f","description":"Specify the ABA routing number of the bank account"},"accountNumber":{"title":"Account number","description":"Account number","type":"string","maxLength":32}}},{"title":"Apple Pay","type":"object","description":"Supports either a payment token or merchant-decrypted payment data. Do not send both. Requests containing both modes return error `400`","required":["type"],"properties":{"type":{"enum":["applePay"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}},"oneOf":[{"title":"Token mode","required":["token"],"properties":{"token":{"type":"string","minLength":1,"maxLength":512}}},{"title":"Decoded mode (merchant decryption)","properties":{"number":{"type":"string","title":"DPAN","description":"Device Primary Account Number (applicationPrimaryAccountNumber)"},"expirationMonth":{"type":"string","title":"Expiration month","description":"Card expiration month, 2 digits","example":"12"},"expirationYear":{"type":"string","title":"Expiration year","description":"Card expiration year, 2 digits","example":"27"},"tavv":{"type":"string","title":"One-time cryptogram","description":"One-time cryptogram from paymentData.onlinePaymentCryptogram","maxLength":32},"eci":{"type":"string","title":"ECI indicator","description":"Electronic Commerce Indicator from paymentData.eciIndicator","maxLength":2,"example":"05"}},"required":["number","expirationMonth","expirationYear","tavv"]}]},{"title":"PIX","type":"object","required":["type"],"properties":{"type":{"enum":["pix"]},"cpf":{"title":"CPF","description":"CPF - valid Brazil tax ID, 11-digit number","type":"string","minLength":11,"maxLength":11,"example":23100299900},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Banktransfer Chile","type":"object","required":["type"],"properties":{"type":{"enum":["banktransferChile"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Webpay Chile","type":"object","required":["type","accountDocType","accountDocId"],"properties":{"type":{"enum":["webpay_chile"]},"accountDocType":{"title":"Consumer’s ID or tax ID","description":"RUT (Rol Único Tributario) – tax ID number (8–9 digits)<br> RUN (Rol Único Nacional) – national ID number (8–9 digits)","enum":["RUT","RUN"],"example":"RUT"},"accountDocId":{"title":"Consumer's ID or tax ID number","type":"string"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Bill1st","type":"object","required":["type"],"properties":{"type":{"enum":["bill1st"]},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}},{"title":"Khipu PayIn","type":"object","required":["type","accountDocType","accountDocId"],"properties":{"type":{"enum":["khipu"]},"accountDocType":{"title":"Consumer’s ID or tax ID","description":"RUT (Rol Único Tributario) – tax ID number (8–9 digits)<br> RUN (Rol Único Nacional) – national ID number (8–9 digits)","enum":["RUT","RUN"],"example":"RUT"},"accountDocId":{"title":"Consumer's ID or tax ID number","type":"string"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"MACH PayIn","type":"object","required":["type","accountDocType","accountDocId"],"properties":{"type":{"enum":["mach"]},"accountDocType":{"title":"Consumer’s ID or tax ID","description":"RUT (Rol Único Tributario) – tax ID number (8–9 digits)<br> RUN (Rol Único Nacional) – national ID number (8–9 digits)","enum":["RUT","RUN"],"example":"RUT"},"accountDocId":{"title":"Consumer's ID or tax ID number","type":"string"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}}]},"partialApproval":{"title":"Partial Approval","type":"object","description":"Optional recommendation to allow partial authorization whenever possible. At least one of `amount` or `percentage` must be provided. If both are provided, the approved amount is calculated as the specified percentage of the payment amount, but must not be less than `amount`. Sending this object does not guarantee a partial approval will occur. Actual support depends on payment methods that support partial approvals","properties":{"amount":{"type":"number","title":"Partial approval amount","description":"Partial approval amount","example":25.5},"percentage":{"type":"number","title":"Partial approval percentage","description":"The percentage of the payment amount to approve","minimum":0,"maximum":100,"example":10}},"minProperties":1},"sku":{"type":"object","oneOf":[{"title":"SKU object with site ID","type":"object","properties":{"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"domainName":{"title":"Domain name (without protocol)","type":"string","minLength":5,"maxLength":36,"example":"google.com","description":"If the property is passed, the site domain name will be replaced"},"price":{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}},"action":{"type":"object","description":"Set the values to retry a transaction with the same order ID after a SCA decline","properties":{"type":{"title":"Retry transaction","type":"string","description":"Set <b>retry</b> to retry the transaction type. Include all parameters required for 3DS","example":"retry"},"id":{"title":"Gateway transaction ID","description":"Gateway transaction ID","type":"string","minLength":5,"maxLength":36,"example":235324530}}}},"required":["siteId","price"]},{"title":"SKU object with SKU name","type":"object","properties":{"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"name":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"},"action":{"type":"object","description":"Set the values to retry a transaction with the same order ID after a SCA decline","properties":{"type":{"title":"Retry transaction","type":"string","description":"Set <b>retry</b> to retry the transaction type. Include all parameters required for 3DS","example":"retry"},"id":{"title":"Gateway transaction ID","description":"Gateway transaction ID","type":"string","minLength":5,"maxLength":36,"example":235324530}}}},"required":["name"]},{"title":"SKU object with SKU name and custom prices","type":"object","properties":{"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"name":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"},"price":{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}},"action":{"type":"object","description":"Set the values to retry a transaction with the same order ID after a SCA decline","properties":{"type":{"title":"Retry transaction","type":"string","description":"Set <b>retry</b> to retry the transaction type. Include all parameters required for 3DS","example":"retry"},"id":{"title":"Gateway transaction ID","description":"Gateway transaction ID","type":"string","minLength":5,"maxLength":36,"example":235324530}}}},"required":["name","price"]}]},"consumer":{"type":"object","required":["ip"],"properties":{"id":{"title":"Gateway consumer ID","description":"Required in case if <b>consumer.externalId</b> or <b>consumer.email</b> are empty","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Required in case if <b>consumer.id</b> is empty","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Required in case if <b>consumer.id</b> is empty","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"Required in case <b>paymentSource.type</b> is <b>SEPA</b> or <b>card</b>","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Required in case <b>paymentSource.type</b> is <b>SEPA</b> or <b>card</b>","type":"string","minLength":1,"maxLength":32},"birthday":{"title":"Customer's date of birth","type":["null","string"],"description":"Date of birth","example":"Yyyy-mm-dd"},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"address":{"title":"Customer's address","type":"string","description":"Address","maxLength":64},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"},"ip":{"title":"IP address","description":"IP address","type":"string","minLength":1,"maxLength":16},"cpf":{"title":"CPF","description":"CPF (valid tax ID), 11-digit number <span style=\"color:red\">Required for PIX transactions</span>","type":"string","minLength":11,"maxLength":11,"example":23100299900},"userAgent":{"title":"Browser user-agent","type":"string","description":"Consumer's consumer agent <span style=\"color:red\">Required for 3DS transactions</span>","maxLength":255},"deviceId":{"title":"Exodentity device ID","type":"string","description":"Exodentity device ID","maxLength":1024},"browserAcceptHeader":{"title":"Browser accept header","type":"string","description":"Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder's browser. <span style=\"color:red\">Required for 3DS transactions</span>"},"browserJavaEnabled":{"title":"Browser java enabled","type":"boolean","description":"Boolean that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. <span style=\"color:red\">Required for 3DS transactions</span>"},"browserLanguage":{"title":"Browser language","type":"string","maxLength":8,"description":"Value representing the browser language as defined in IETF BCP47. The value is limited to 1-8 characters. Value is returned from navigator.language property. <span style=\"color:red\">Required for 3DS transactions</span>"},"browserColorDepth":{"title":"Browser color depth","type":"integer","description":"Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property. <span style=\"color:red\">Required for 3DS transactions</span>"},"browserScreenHeight":{"title":"Browser screen height","type":"integer","description":"Total height of the Cardholder's screen in pixels. Value is returned from the screen.height property. <span style=\"color:red\">Required for 3DS transactions</span>"},"browserScreenWidth":{"title":"Browser screen width","type":"integer","description":"Total width of the Cardholder's screen in pixels. Value is returned from the screen.width property <span style=\"color:red\">Required for 3DS transactions</span>"},"browserTimezone":{"title":"Browser timezone","type":"string","description":"Time difference between UTC time and the Cardholder browser local time, in minutes. The field is limited to 1-5 characters where the value is returned from the getTimezoneOffset() method. <span style=\"color:red\">Required for 3DS transactions</span>"}}},"url":{"type":"object","properties":{"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"emailOptions":{"title":"Email options","type":"object","properties":{"send":{"type":"boolean","description":"Set to <b>true</b> by default (in case the email is activated for your Merchant account). Use <b>true</b> to send an email about payment. The value is inherited for all transaction chains (rebill/void/refund/etc.). Check with your account manager which emails you have enabled"}},"example":true}},"required":["paymentSource","sku","consumer","url"],"example":{"paymentSource":{"type":"card","number":"4024007179366348","expirationMonth":"11","expirationYear":"22","cvv":"100","3ds":false},"sku":{"title":"Product name","siteId":"983759353","price":[{"offset":"0d","amount":19.99,"currency":"USD","repeat":false}]},"consumer":{"id":"4242522","email":"jonny.sonny@google.com","firstName":"John","lastName":"Doe","phone":"+1987353539","country":"USA","state":"Alabama","city":"Montgomery","zip":"36101","ip":"8.8.8.8","userAgent":"mozilla/5.0 (iphone; cpu iphone os 13_1_2 like mac os x) applewebkit/605.1.15 (khtml, like gecko) version/13.0.1 mobile/15e148 safari/604.1","deviceId":"1.1|hfp9sLiKhAoWyNSMpiQGh|mozilla/5.0 (windows nt 6.1) applewebkit/537.36 (khtml, like gecko) chrome/92.0.4515.131 safari/537.36|24#1344#840#799|internal-pdf-viewer#mhjfbmdgcfjbbpaeojofohoefgiehjai#internal-nacl-plugin|Win32|1g0u1g01u0u10r1u0x10g1y0g1d0g10g1010u101g0g1u01r0x10x101g01a010u101g01010u101r01z01ij01a0u1u01rd01r0r101ir01ii01aj01ux01ui01iy01y01ui0g1y01r01d0|MS|-1397920487|c39b35be"},"url":{"ipnUrl":"https://google.com/gateway/webhook/245252525252525","redirectUrl":"https://google.com/gateway/redirect/245252525252525"},"metadata":{"foo":"bar"},"emailOptions":{"send":true}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent payment result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["redirect","charge"],"example":"charge","description":"|  action name | description |\n|---|---|\n| charge | Card will be charged immediately.  |\n| redirect | Consumer should be redirected to url for second step |","title":"The default action that should be undertaken"},"url":{"type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"URL"},"qrCode":{"type":"string","example":"00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381","description":"String to convert to a QR code"},"mode":{"type":"string","enum":["sale","auth"],"title":"Payment mode","description":"Payment mode","example":"sale"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99},"orderId":{"type":"string","description":"Gateway transaction ID","minLength":5,"maxLength":36,"example":"235324530"},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"402400****6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"disabled":{"type":"boolean","description":"If set to <b>true</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/disablepaymentaccountforquicksale\">deactivated for quick sale transactions</a>. If set to <b>false</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/enablepaymentaccountforquicksale\">activated for quick sale transactions</a>. Refer to the appropriate methods to disable or enable the <b>paymentAccountId</b>."}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"subscription":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Subscription status","description":"Subscription status","example":"active","nullable":true},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","description":"Expected date of renewal","example":"2020-04-17 13:43:02","nullable":true},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","description":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0,"nullable":true}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}},"callbacks":{"paymentEvent":{"{$request.body.url.ipnUrl}":{"summary":"Payment status callback","post":{"summary":"Payment status callback","requestBody":{"content":{"application/json":{"schema":{"title":"Object to represent payment result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["redirect","charge"],"example":"charge","description":"|  action name | description |\n|---|---|\n| charge | Card will be charged immediately.  |\n| redirect | Consumer should be redirected to url for second step |","title":"The default action that should be undertaken"},"url":{"type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"URL"},"qrCode":{"type":"string","example":"00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381","description":"String to convert to a QR code"},"mode":{"type":"string","enum":["sale","auth"],"title":"Payment mode","description":"Payment mode","example":"sale"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99},"orderId":{"type":"string","description":"Gateway transaction ID","minLength":5,"maxLength":36,"example":"235324530"},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"402400****6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"disabled":{"type":"boolean","description":"If set to <b>true</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/disablepaymentaccountforquicksale\">deactivated for quick sale transactions</a>. If set to <b>false</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/enablepaymentaccountforquicksale\">activated for quick sale transactions</a>. Refer to the appropriate methods to disable or enable the <b>paymentAccountId</b>."}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"subscription":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Subscription status","description":"Subscription status","example":"active","nullable":true},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","description":"Expected date of renewal","example":"2020-04-17 13:43:02","nullable":true},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","description":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0,"nullable":true}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}}}}}},"responses":{"200":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"201":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"202":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"}}}}}}}},"/paymentPage":{"post":{"tags":["Payment page"],"summary":"Hosted payment page","operationId":"generateUrlToPaymentPage","description":"","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload to generate link of payment page","type":"object","properties":{"sku":{"type":"array","items":{"oneOf":[{"title":"SKU object with site ID","type":"object","properties":{"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"domainName":{"title":"Domain name (without protocol)","type":"string","minLength":5,"maxLength":36,"example":"google.com","description":"If the property is passed, the site domain name will be replaced"},"price":{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}},"url":{"type":"object","properties":{"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"}}},"action":{"type":"object","description":"Set the values to retry a transaction with the same order ID after a SCA decline","properties":{"type":{"title":"Retry transaction","type":"string","description":"Set <b>retry</b> to retry the transaction type. Include all parameters required for 3DS","example":"retry"},"id":{"title":"Gateway transaction ID","description":"Gateway transaction ID","type":"string","minLength":5,"maxLength":36,"example":235324530}}},"xsell":{"enum":["checked","unchecked"]}},"required":["siteId","price","url"]},{"title":"SKU object with SKU name","type":"object","properties":{"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"name":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"},"domainName":{"title":"Domain name (without protocol)","type":"string","minLength":5,"maxLength":36,"example":"google.com","description":"If the property is passed, the site domain name will be replaced"},"url":{"type":"object","properties":{"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"}}},"action":{"type":"object","description":"Set the values to retry a transaction with the same order ID after a SCA decline","properties":{"type":{"title":"Retry transaction","type":"string","description":"Set <b>retry</b> to retry the transaction type. Include all parameters required for 3DS","example":"retry"},"id":{"title":"Gateway transaction ID","description":"Gateway transaction ID","type":"string","minLength":5,"maxLength":36,"example":235324530}}},"xsell":{"enum":["checked","unchecked"]}},"required":["name","price","url"]},{"title":"SKU object with SKU name and custom prices","type":"object","properties":{"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"name":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"},"domainName":{"title":"Domain name (without protocol)","type":"string","minLength":5,"maxLength":36,"example":"google.com","description":"If the property is passed, the site domain name will be replaced"},"price":{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}},"url":{"type":"object","properties":{"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"}}},"action":{"type":"object","description":"Set the values to retry a transaction with the same order ID after a SCA decline","properties":{"type":{"title":"Retry transaction","type":"string","description":"Set <b>retry</b> to retry the transaction type. Include all parameters required for 3DS","example":"retry"},"id":{"title":"Gateway transaction ID","description":"Gateway transaction ID","type":"string","minLength":5,"maxLength":36,"example":235324530}}},"xsell":{"enum":["checked","unchecked"]}},"required":["name","price","url"]}]}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway user ID","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"User ID assigned within your system","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"User email","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"User first name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"User last name","type":"string","minLength":1,"maxLength":32},"birthday":{"title":"Customer's date of birth","type":["null","string"],"description":"Date of birth","example":"Yyyy-mm-dd"},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"address":{"title":"Customer's address","type":"string","description":"Address","maxLength":64},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"},"ip":{"title":"IP address","description":"Required in case if <b>payment.selected</b> or <b>payment.method</b> are not empty","type":"string","minLength":1,"maxLength":16},"deviceId":{"title":"Exodentity device ID","type":"string","description":"Exodentity device ID","maxLength":1024}}},"template":{"title":"Template","type":"object","properties":{"language":{"type":"string","format":"ISO2","title":"Payment page language","description":"Payment page language. If empty, omitted, or unsupported - Gateway will determine it automatically based on the browser settings and the geographical location of the user","example":"DE"},"layout":{"type":"string","title":"Payment page layout","description":"Payment page layout (theme). If empty, omitted, or unsupported - Gateway will use the default theme"},"templateParameters":{"type":"object","title":"Payment page custom parameters","description":"Key → value list of layout parameters","example":{"foo":"bar"}}}},"payment":{"title":"Payment","type":"object","properties":{"method":{"type":"array","items":{"anyOf":[{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"}]}},"selected":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"secure":{"type":"boolean","title":"Secure payment","description":"If <b>true</b>, Gateway will attempt additional payment verification (such as 3DSecure). Gateway will determine it automatically. Set to <b>true</b> by default","example":true},"test":{"type":"boolean","title":"Test mode","description":"Indicates if the payment will be processed in test mode","example":false},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36},"terminalMode":{"type":"boolean","title":"Terminal mode","description":"Indicates if the payment is in terminal mode (without consumer tracking, one-clicks, or antifraud checks)","example":false},"bin":{"title":"Bank Identification Number","description":"First 6 to 8 digits on the bank card","type":"integer","minLength":100000,"maxLength":99999999},"domain":{"type":"string","title":"Domain","minLength":5,"maxLength":36,"description":"Enter the domain name to be displayed in the link instead of the default https://app.customdomain.com","example":"https://checkout2.centrobill.com"},"partialApproval":{"title":"Partial Approval","type":"object","description":"Optional recommendation to allow partial authorization whenever possible. At least one of `amount` or `percentage` must be provided. If both are provided, the approved amount is calculated as the specified percentage of the payment amount, but must not be less than `amount`. Sending this object does not guarantee a partial approval will occur. Actual support depends on payment methods that support partial approvals","properties":{"amount":{"type":"number","title":"Partial approval amount","description":"Partial approval amount","example":25.5},"percentage":{"type":"number","title":"Partial approval percentage","description":"The percentage of the payment amount to approve","minimum":0,"maximum":100,"example":10}},"minProperties":1}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"ttl":{"type":"integer","title":"Payment page lifetime","description":"The payment page lifetime in seconds. By default, set to 600","example":600},"emailOptions":{"title":"Email options","type":"object","properties":{"send":{"type":"boolean","description":"Set to <b>true</b> by default (in case the email is activated for your Merchant account). Use <b>true</b> to send an email about payment. The value is inherited for all transaction chains (rebill/void/refund/etc.). Check with your account manager which emails you have enabled"}},"example":true}},"required":["sku"],"example":{"sku":[{"name":"TEST_EN_00","siteId":"1811","price":[{"offset":"0d","amount":29.37,"currency":"USD","repeat":false},{"offset":"60d","amount":50,"currency":"USD","repeat":false},{"offset":"30d","amount":30,"currency":"USD","repeat":true}],"currency":"USD","title":"30 day recurring + First 30 Days For Free","url":{"redirectUrl":"https://google.com/payment/gateway/success","ipnUrl":"https://google.com/callback"}}],"consumer":{"id":"59024134","externalId":"some-12958305390","firstName":"John","lastName":"Doe","email":"someuser2020130110@google.com"},"payment":{"method":["card","sepa"],"selected":"card","secure":true,"test":false,"mid":"s938503530f"},"metadata":{"trackingId":"98530968732-93625235"},"emailOptions":{"send":true},"ttl":1200}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent payment page URL","type":"object","properties":{"url":{"title":"Redirect URL","type":"string","description":"Gateway payment page URL to which you redirect your user","example":"https://pay.centrobill.com/unique-hash"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}},"callbacks":{"paymentEvent":{"{$request.body.url.ipnUrl}":{"summary":"Payment status callback","post":{"summary":"Payment status callback","operationId":"paymentStatusCallback","requestBody":{"content":{"application/json":{"schema":{"title":"Object to represent payment result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["redirect","charge"],"example":"charge","description":"|  action name | description |\n|---|---|\n| charge | Card will be charged immediately.  |\n| redirect | Consumer should be redirected to url for second step |","title":"The default action that should be undertaken"},"url":{"type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"URL"},"qrCode":{"type":"string","example":"00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381","description":"String to convert to a QR code"},"mode":{"type":"string","enum":["sale","auth"],"title":"Payment mode","description":"Payment mode","example":"sale"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99},"orderId":{"type":"string","description":"Gateway transaction ID","minLength":5,"maxLength":36,"example":"235324530"},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"402400****6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"disabled":{"type":"boolean","description":"If set to <b>true</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/disablepaymentaccountforquicksale\">deactivated for quick sale transactions</a>. If set to <b>false</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/enablepaymentaccountforquicksale\">activated for quick sale transactions</a>. Refer to the appropriate methods to disable or enable the <b>paymentAccountId</b>."}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"subscription":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Subscription status","description":"Subscription status","example":"active","nullable":true},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","description":"Expected date of renewal","example":"2020-04-17 13:43:02","nullable":true},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","description":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0,"nullable":true}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}}}}}},"responses":{"200":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"201":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"202":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"}}}}}}}},"/payment/{id}/credit":{"post":{"tags":["Payment"],"summary":"Credit","operationId":"credit","description":"","parameters":[{"name":"id","in":"path","description":"Transaction that should be credited","schema":{"type":"string"},"required":true},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload to make credit","type":"object","properties":{"amount":{"title":"Amount of operation","description":"If the parameter is not passed, full amount is credited","type":"number","format":"double","example":9.99},"reason":{"title":"Reason of operation","description":"Reason of operation","type":"string","minLength":3,"maxLength":64,"example":"Retention offer"}},"required":["reason"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent credit","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"enum":["credit"],"example":"credit","description":"|  action name | description |\n|---|---|\n| credit |  Return the previously charged amount to the customer |","title":"The default action that should be undertaken"},"mode":{"enum":["refund","void"],"title":"Payment mode","description":"Payment mode","example":"refund"},"status":{"enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"orderId":{"title":"Gateway transaction ID","description":"Gateway transaction ID","type":"string","minLength":5,"maxLength":36,"example":235324530},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"parentTransactionId":{"type":"string","example":"735101832"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"4024******6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}},"vat":{"type":"object","properties":null,"amount":{"type":"number","example":0},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}},"callbacks":{"paymentEvent":{"{$request.body.url.ipnUrl}":{"summary":"Payment status callback","post":{"summary":"Payment status callback","operationId":"paymentStatusCallback","requestBody":{"content":{"application/json":{"schema":{"title":"Object to represent payment result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["redirect","charge"],"example":"charge","description":"|  action name | description |\n|---|---|\n| charge | Card will be charged immediately.  |\n| redirect | Consumer should be redirected to url for second step |","title":"The default action that should be undertaken"},"url":{"type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"URL"},"qrCode":{"type":"string","example":"00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381","description":"String to convert to a QR code"},"mode":{"type":"string","enum":["sale","auth"],"title":"Payment mode","description":"Payment mode","example":"sale"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99},"orderId":{"type":"string","description":"Gateway transaction ID","minLength":5,"maxLength":36,"example":"235324530"},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"402400****6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"disabled":{"type":"boolean","description":"If set to <b>true</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/disablepaymentaccountforquicksale\">deactivated for quick sale transactions</a>. If set to <b>false</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/enablepaymentaccountforquicksale\">activated for quick sale transactions</a>. Refer to the appropriate methods to disable or enable the <b>paymentAccountId</b>."}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"subscription":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Subscription status","description":"Subscription status","example":"active","nullable":true},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","description":"Expected date of renewal","example":"2020-04-17 13:43:02","nullable":true},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","description":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0,"nullable":true}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}}}}}},"responses":{"200":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"201":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"202":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"}}}}}}}},"/payout":{"post":{"tags":["Payout"],"summary":"Payout","operationId":"payout","description":"","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload to make payout","type":"object","properties":{"consumerId":{"type":"string","description":"Gateway consumer ID (user ID)","minLength":5,"maxLength":36},"consumer":{"type":"object","properties":{"email":{"title":"Consumer email","description":"Email address. Required if you do not use **consumerId** parameter in request.","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"ip":{"title":"IP address","description":"IPv4 or IPv6. Required if you do not use **consumerId** parameter in request.","type":"string","minLength":1,"maxLength":16}}},"paymentAccountId":{"description":"ID of the encoded user payment details","type":"string","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"siteId":{"title":"Gateway site ID","description":"Payout will be linked to the passed <b>siteId</b>, otherwise – to the first merchant site","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"parameters":{"oneOf":[{"title":"Card","type":"object","required":["type","number","expirationMonth","expirationYear","birthDay","firstName","lastName"],"properties":{"type":{"enum":["card"]},"number":{"title":"Card number","description":"Full card number","type":"string","minLength":12,"maxLength":19,"example":"4433221100998877"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32,"example":"John"},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32,"example":"Doe"},"expirationMonth":{"title":"Card expiration month","description":"The expiry month of the card","type":"string","minLength":2,"maxLength":2,"example":"12"},"expirationYear":{"title":"Card expiration year","description":"The expiry year of the card","type":"string","minLength":2,"maxLength":2,"example":"27"},"birthday":{"title":"Customer's date of birth","type":["null","string"],"description":"Date of birth","example":"1984-01-03"}}},{"title":"PayId","type":"object","required":["type","payid"],"properties":{"type":{"enum":["payid"]},"payid":{"title":"PayId","type":"string","description":"Valid email or phone number should be provided in this parameter.","example":"johny.sonny@gmail.com OR 1111111111"}}},{"title":"Crypto","type":"object","required":["type"],"properties":{"type":{"enum":["crypto"]},"address":{"title":"Blockchain address","type":"string","example":"bc1q2etwn9k5dsq23sth5hw6kr00ekmhejdxuvk8ts","description":"Blockchain address"},"blockchain":{"title":"Blockchain","enum":["BTC","ETH","LTC","BCH","DOGE","DASH","TRX","BNB","XMR","USDT-TRC20","USDT-ERC20","USDT-BEP20"],"description":"Blockchain","example":"BTC"}}},{"title":"ACH","type":"object","required":["type","fullName","accountType","abaNumber","accountNumber","currency"],"properties":{"type":{"enum":["ach"]},"fullName":{"title":"Consumer full name","description":"Full name","type":"string","minLength":1,"maxLength":64,"example":"Jonny Sonny"},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"address":{"title":"Customer's address","type":"string","description":"Address","maxLength":64},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"accountType":{"title":"Account type","enum":["С","S"],"description":"Specify account type. C - for checking account, S - for savings account"},"abaNumber":{"title":"ABA number","type":"string","maxLength":32,"example":"122059ifs0f","description":"Specify the ABA routing number of the bank account"},"accountNumber":{"title":"Account number","description":"Account number","type":"string","maxLength":32},"code":{"oneOf":[{"title":"CCD"},{"title":"PPD"}],"description":"Use CCD for business accounts, PPD - for private"}}},{"title":"SEPA","type":"object","required":["type","iban","fullName"],"properties":{"type":{"enum":["sepa"]},"iban":{"type":"string","minLength":5,"maxLength":34,"title":"International bank account number ISO-13616","description":"International bank account number in ISO-13616 format","example":null},"fullName":{"title":"Consumer full name","description":"Full name","type":"string","minLength":1,"maxLength":64,"example":"Jonny Sonny"}}},{"title":"Pix","type":"object","required":["type","address","city","zip","firstName","lastName"],"properties":{"type":{"enum":["pix"]},"address":{"title":"Customer's address","type":"string","description":"Address","maxLength":64},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"cpf":{"title":"CPF","description":"CPF - valid Brazil tax ID, 11-digit number","type":"string","minLength":11,"maxLength":11,"example":23100299900},"cnpj":{"title":"CNPJ","description":"CNPJ - a 14-digit Brazil national registry of legal entities number","type":"integer","minLength":14,"maxLength":14,"example":623909000173},"evp":{"title":"EVP","description":"EVP - Endereço Virtual de Pagamento é um tipo de chave gerado pelo DICT","type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","example":"123e4567-e89b-12d3-a456-426655440000"}}},{"title":"Netbanking","type":"object","required":["type","firstName","lastName","email","phone","state","zip","countryCode","bankCode","bankName","bankBranch","bankBranchCode","accountNumber"],"properties":{"type":{"enum":["banktransfer"]},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32,"example":"Rajesh"},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32,"example":"Koothrappali"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"raj.koot24041999@google.com"},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+9876543210"},"address":{"title":"Customer's address","type":"string","description":"Address","maxLength":64,"example":"1st floor, 4126, K. Dubhash Marg, 30, K Dubash Marg, Kala Ghoda 4126"},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50,"example":"Mumbai"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32,"example":"Maharashtra"},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"},"countryCode":{"title":"Consumer's country","description":"Country name in ISO2 format","type":"string","format":"ISO2","example":"IN"},"bankCode":{"title":"Bank Code","description":"Bank code","type":"string","maxLength":20,"example":"1111111"},"bankName":{"title":"Bank Name","description":"Bank name","type":"string","maxLength":100,"example":"Bank of India"},"bankBranch":{"title":"Bank Branch","description":"Spaces (\" \") are not allowed. Use an underscore (\"_\") if a separator is needed.","type":"string","maxLength":100,"example":"NA"},"bankBranchCode":{"title":"Bank Branch Code","description":"Bank branch code","type":"string","maxLength":20,"example":"NG1084"},"bankAddress":{"title":"Bank Address","description":"Bank address","type":"string","maxLength":100,"example":"BANK OF INDIA STAR HOUSE C - 5, G Block, Bandra Kurla Complex"},"accountNumber":{"title":"Account number","description":"Account number","type":"string","maxLength":32,"example":"2000017251"},"documentId":{"title":"Document ID","description":"Document ID","type":"string","maxLength":50,"example":"123"},"documentType":{"title":"Document Type","description":"Document type","type":"string","maxLength":50,"example":"na"}}},{"title":"Token of tokenized card data for payouts","type":"object","required":["type","value","firstName","lastName"],"properties":{"type":{"enum":["token"]},"value":{"type":"string","description":"Token you have generated after using the Tokenization method.","minLength":5,"maxLength":36},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32}}},{"title":"Chile_transfers","type":"object","required":["type","account","accountBank","accountDocType","accountDocId","firstName","lastName"],"properties":{"type":{"enum":["chile_transfers"]},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"account":{"description":"Customer's bank account number","type":"string"},"accountType":{"title":"Account type","description":"Customer's account type","enum":["CC","SVGS","VISTA","RUT","SLRY","CORRIENTE","AHORRO"]},"accountBank":{"title":"Account bank number (Chile)","description":"Customer's bank code <br> 29 - Banco de Chile/Banco A Edwards/Credichile/Citibank <br> 30 - Banco del Estado de Chile <br> 32 - Banco de Crédito e Inversiones (BCI)/Tbank<br> 33 - Banco Corpbanca<br> 34 - Banco Bice<br> 35 - Banco Santander (Santiago)/Santander/Banefe<br> 36 - Banco Itaú Chile<br> 38 - Banco Security<br> 39 - Banco Falabella<br> 58 - BBVA<br> 64 - Banco Consorcio<br> 65 - Banco Ripley<br> 67 - Banco Coopeuch<br> 69 - Banco Internacional<br> 113 - Scotiabank Sudamericano","type":"string","enum":["29","30","32","33","34","35","36","38","39","58","64","65","67","69","113"],"example":"67"},"accountDocType":{"title":"Consumer’s ID or tax ID","description":"RUT (Rol Único Tributario) – tax ID number (8–9 digits)<br> RUN (Rol Único Nacional) – national ID number (8–9 digits)","enum":["RUT","RUN"],"example":"RUT"},"accountDocId":{"title":"Consumer's ID or tax ID number","type":"string"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32}}}],"description":"Payout method"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Operation currency. If your currency is not supported, we will automatically convert it to USD","format":"ISO3","example":"USD"},"url":{"type":"object","properties":{"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}}},"required":["amount","currency"],"example":{"consumerId":"41098035","paymentAccountId":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb","siteId":983759353,"amount":9.99,"currency":"USD","url":{"ipnUrl":"https://google.com/gateway/webhook/245252525252525"},"metadata":{"foo":"bar"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent payout result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["charge"],"example":"charge"},"mode":{"type":"string","enum":["payout"],"title":"Payment mode","example":"payout"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"orderId":{"title":"Gateway transaction ID","description":"Gateway transaction ID","type":"string","minLength":5,"maxLength":36,"example":235324530},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"source":{"type":"object","properties":{"method":{"enum":["card"],"title":"Payment method","description":"Payment method","example":"card"},"number":{"type":"string","description":"Masked card number (PAN)","title":"Masked card number","example":"402400****6348"},"brand":{"type":"string","title":"Card brand","description":"Card brand","example":"visa"}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}},"callbacks":{"paymentEvent":{"{$request.body.url.ipnUrl}":{"summary":"Payment status callback","post":{"summary":"Payment status callback","operationId":"paymentStatusCallback","requestBody":{"content":{"application/json":{"schema":{"title":"Object to represent payment result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["redirect","charge"],"example":"charge","description":"|  action name | description |\n|---|---|\n| charge | Card will be charged immediately.  |\n| redirect | Consumer should be redirected to url for second step |","title":"The default action that should be undertaken"},"url":{"type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"URL"},"qrCode":{"type":"string","example":"00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381","description":"String to convert to a QR code"},"mode":{"type":"string","enum":["sale","auth"],"title":"Payment mode","description":"Payment mode","example":"sale"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99},"orderId":{"type":"string","description":"Gateway transaction ID","minLength":5,"maxLength":36,"example":"235324530"},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"402400****6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"disabled":{"type":"boolean","description":"If set to <b>true</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/disablepaymentaccountforquicksale\">deactivated for quick sale transactions</a>. If set to <b>false</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/enablepaymentaccountforquicksale\">activated for quick sale transactions</a>. Refer to the appropriate methods to disable or enable the <b>paymentAccountId</b>."}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"subscription":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Subscription status","description":"Subscription status","example":"active","nullable":true},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","description":"Expected date of renewal","example":"2020-04-17 13:43:02","nullable":true},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","description":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0,"nullable":true}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}}}}}},"responses":{"200":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"201":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"202":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"}}}}}}}},"/subscription/{id}":{"get":{"tags":["Subscription"],"summary":"Get subscription","operationId":"getSubscription","description":"","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}},{"in":"path","name":"id","schema":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36},"required":true,"description":"Subscription ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Status of subscription","example":"active"},"type":{"enum":["trial","free-trial","regular"],"title":"Subscription type"},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0},"skuName":{"type":"string","title":"Gateway SKU name","example":"TEST_EN"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","example":"2020-04-17 13:43:02"},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"consumerId":{"description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}},"put":{"tags":["Subscription"],"summary":"Change subscription recurrent plan","operationId":"changeSubscription","description":"","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}},{"in":"path","name":"id","schema":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36},"required":true,"description":"Subscription ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload of subscription","type":"object","properties":{"price":{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}},"metadata":{"type":"object","description":"Use to add additional information and related data"}}}}}},"responses":{"200":{"description":"Updated","content":{"application/json":{"schema":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Status of subscription","example":"active"},"type":{"enum":["trial","free-trial","regular"],"title":"Subscription type"},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0},"skuName":{"type":"string","title":"Gateway SKU name","example":"TEST_EN"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","example":"2020-04-17 13:43:02"},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"consumerId":{"description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/subscription/{id}/cancel":{"put":{"tags":["Subscription"],"summary":"Cancel subscription","operationId":"cancelSubscription","description":"","parameters":[{"in":"path","name":"id","schema":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36},"required":true,"description":"Subscription ID"},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload to cancel subscription","type":"object","properties":{"cancelDate":{"type":"string","format":"date-time","title":"Date of cancel","example":"2020-11-17 13:43:02","nullable":true,"description":"If <b>cancelDate</b> is not passed or is set to <b>null</b>, subscription will be canceled immediately"},"reason":{"type":"string","maxLength":255,"example":"Request from customer","nullable":true,"description":"Provide the reason for subscription cancellation"},"sendEmail":{"type":"boolean","description":"Send an email upon subscription cancellation. Set to <b>true</b> by default"},"keepActiveUntilNextRebill":{"type":"boolean","description":"If passed, <b>cancelDate</b> will be set to 1 hour before the expected rebill date, overriding any previously passed <b>cancelDate</b> value"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Status of subscription","example":"active"},"type":{"enum":["trial","free-trial","regular"],"title":"Subscription type"},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0},"skuName":{"type":"string","title":"Gateway SKU name","example":"TEST_EN"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","example":"2020-04-17 13:43:02"},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"consumerId":{"description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/subscription/{id}/recover":{"put":{"tags":["Subscription"],"summary":"Recover already canceled subscription","operationId":"recoverSubscription","description":"","parameters":[{"in":"path","name":"id","schema":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36},"required":true,"description":"Subscription ID"},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Subscription recovery reason","x-stoplight":{"id":"0961fcfb8d752"},"type":"object","properties":{"reason":{"description":"Provide the reason for subscription recovery","type":"string","maxLength":255,"nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Status of subscription","example":"active"},"type":{"enum":["trial","free-trial","regular"],"title":"Subscription type"},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0},"skuName":{"type":"string","title":"Gateway SKU name","example":"TEST_EN"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","example":"2020-04-17 13:43:02"},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"consumerId":{"description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/site":{"post":{"tags":["Site"],"summary":"Create site","operationId":"createSite","description":"","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload of site","type":"object","properties":{"name":{"title":"Site name","type":"string","description":"URL without protocol prefix","example":"example.com"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"},"clientId":{"name":"Client ID","type":"string","description":"If you have multiple <b>clientId</b> values, specify the one for which you want to create the website"}},"required":["name","ipnUrl"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent site","type":"object","properties":{"id":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"name":{"title":"Site name","type":"string","description":"URL without protocol prefix","example":"example.com"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"},"createdAt":{"type":"string","format":"date-time","title":"Date of site create","example":"2020-04-17 13:43:02"},"updatedAt":{"type":"string","format":"date-time","title":"Date of site last update","example":"2020-11-17 13:43:02"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/site/{id}":{"get":{"tags":["Site"],"summary":"Get site","operationId":"getSite","description":"","parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent site","type":"object","properties":{"id":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"name":{"title":"Site name","type":"string","description":"URL without protocol prefix","example":"example.com"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"},"createdAt":{"type":"string","format":"date-time","title":"Date of site create","example":"2020-04-17 13:43:02"},"updatedAt":{"type":"string","format":"date-time","title":"Date of site last update","example":"2020-11-17 13:43:02"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}},"put":{"tags":["Site"],"summary":"Update site","operationId":"updateSite","description":"","parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload of site","type":"object","properties":{"name":{"title":"Site name","type":"string","description":"URL without protocol prefix","example":"example.com"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"},"clientId":{"name":"Client ID","type":"string","description":"If you have multiple <b>clientId</b> values, specify the one for which you want to create the website"}}}}}},"responses":{"200":{"description":"Updated","content":{"application/json":{"schema":{"title":"Object to represent site","type":"object","properties":{"id":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"name":{"title":"Site name","type":"string","description":"URL without protocol prefix","example":"example.com"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"ipnUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/gateway/webhook/245252525252525","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase"},"redirectUrl":{"title":"URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"User will be redirected to this URL after purchase"},"createdAt":{"type":"string","format":"date-time","title":"Date of site create","example":"2020-04-17 13:43:02"},"updatedAt":{"type":"string","format":"date-time","title":"Date of site last update","example":"2020-11-17 13:43:02"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/site/{id}/sku":{"get":{"tags":["Product"],"summary":"List products (SKUs) by site","operationId":"getSiteIdSku","description":"Returns a paginated list of SKUs for the specified site. The `id` path parameter must be numeric. Non-numeric values return 404.","parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":100},"description":"Page size"},{"name":"active","in":"query","required":false,"schema":{"type":"boolean"},"description":"Filter by active status. `true` = active SKUs, `false` = disabled"},{"name":"editable","in":"query","required":false,"schema":{"type":"boolean"},"description":"Filter by editability. `true` = no sales yet, `false` = has sales"},{"name":"type[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["one-time","subscription"]}},"description":"Filter by SKU type"},{"name":"description","in":"query","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"schema":{"type":"string"},"description":"Exact SKU name"},{"name":"currency[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","minLength":3,"maxLength":3}},"description":"Filter by currency code (e.g. USD, EUR)"},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"List of SKUs","type":"object","properties":{"data":{"type":"array","description":"List of SKUs matching the applied filters","items":{"title":"Object to represent SKU","type":"object","properties":{"name":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"i18n":{"title":"Localized SKU titles","type":"object","description":"Localized SKU titles. Only provided locales will be returned","properties":{"title":{"type":"object","properties":{"de":{"type":"string"},"nl":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"},"ja":{"type":"string"},"zh":{"type":"string"},"es":{"type":"string"},"pt":{"type":"string"},"ar":{"type":"string"}}}}},"active":{"type":"boolean","description":"Indicates whether the SKU is active"},"editable":{"type":"boolean","description":"Indicates whether the SKU can be edited. \"False\" when the SKU has existing sales (successful, shipped, or test transactions)"},"type":{"title":"Type of product (SKU)","enum":["one-time","subscription"],"description":"| type | description |\n|---|---|\n| one-time | single payment |\n| subscription | recurrent payments | "},"price":{"title":"Price","oneOf":[{"title":"Amount of product","description":"Amount of operation","type":"number","format":"double","example":9.99},{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}}]},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"createdAt":{"type":"string","format":"date-time","title":"Date of product create","example":"2020-04-17 13:43:02"},"updatedAt":{"type":"string","format":"date-time","title":"Date of product last update","example":"2020-11-17 13:43:02"}}}},"meta":{"type":"object","description":"Pagination metadata","properties":{"currentPage":{"type":"integer","description":"Current page number","example":1},"lastPage":{"type":"integer","description":"Last available page","example":3},"perPage":{"type":"integer","description":"Page size (the requested limit)","example":20},"total":{"type":"integer","description":"Total number of SKUs matching the filters across all pages","example":42}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"404":{"description":"Not Found — site id is non-numeric or does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found"}},"required":["message"]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/sku":{"post":{"tags":["Product"],"summary":"Create product (SKU)","operationId":"createProduct","description":"","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload of SKU","type":"object","oneOf":[{"title":"Recurring SKU","properties":{"type":{"enum":["subscription"],"description":"Recurring product"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"title":{"title":"Product (SKU) description","type":"string","minLength":3,"maxLength":128,"description":"The product description that will be shown on the payment page","example":"Annual subscription"},"i18n":{"title":"Localized SKU titles","type":"object","description":"Localized SKU titles. Only provided locales will be returned","properties":{"title":{"type":"object","properties":{"de":{"type":"string"},"nl":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"},"ja":{"type":"string"},"zh":{"type":"string"},"es":{"type":"string"},"pt":{"type":"string"},"ar":{"type":"string"}}}}},"active":{"type":"boolean","description":"Indicates whether the SKU is active."},"externalId":{"title":"Merchant SKU ID","description":"Merchant SKU ID","type":"string","minLength":3,"maxLength":36,"example":"7f9s7f9sfs9"},"price":{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}}},"required":["title","type","price","siteId"]},{"title":"One-time SKU","properties":{"type":{"enum":["one-time"],"description":"One-time product"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"i18n":{"title":"Localized SKU titles","type":"object","description":"Localized SKU titles. Only provided locales will be returned","properties":{"title":{"type":"object","properties":{"de":{"type":"string"},"nl":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"},"ja":{"type":"string"},"zh":{"type":"string"},"es":{"type":"string"},"pt":{"type":"string"},"ar":{"type":"string"}}}}},"active":{"type":"boolean","description":"Indicates whether the SKU is active"},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99}},"required":["title","type","siteId","currency","amount"]}],"required":["title","siteId","type","price"]}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent SKU","type":"object","properties":{"name":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"i18n":{"title":"Localized SKU titles","type":"object","description":"Localized SKU titles. Only provided locales will be returned","properties":{"title":{"type":"object","properties":{"de":{"type":"string"},"nl":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"},"ja":{"type":"string"},"zh":{"type":"string"},"es":{"type":"string"},"pt":{"type":"string"},"ar":{"type":"string"}}}}},"active":{"type":"boolean","description":"Indicates whether the SKU is active"},"editable":{"type":"boolean","description":"Indicates whether the SKU can be edited. \"False\" when the SKU has existing sales (successful, shipped, or test transactions)"},"type":{"title":"Type of product (SKU)","enum":["one-time","subscription"],"description":"| type | description |\n|---|---|\n| one-time | single payment |\n| subscription | recurrent payments | "},"price":{"title":"Price","oneOf":[{"title":"Amount of product","description":"Amount of operation","type":"number","format":"double","example":9.99},{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}}]},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"createdAt":{"type":"string","format":"date-time","title":"Date of product create","example":"2020-04-17 13:43:02"},"updatedAt":{"type":"string","format":"date-time","title":"Date of product last update","example":"2020-11-17 13:43:02"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/sku/{name}":{"get":{"tags":["Product"],"summary":"Get product (SKU)","operationId":"getProduct","description":"","parameters":[{"name":"name","in":"path","required":true,"schema":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent SKU","type":"object","properties":{"name":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"i18n":{"title":"Localized SKU titles","type":"object","description":"Localized SKU titles. Only provided locales will be returned","properties":{"title":{"type":"object","properties":{"de":{"type":"string"},"nl":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"},"ja":{"type":"string"},"zh":{"type":"string"},"es":{"type":"string"},"pt":{"type":"string"},"ar":{"type":"string"}}}}},"active":{"type":"boolean","description":"Indicates whether the SKU is active"},"editable":{"type":"boolean","description":"Indicates whether the SKU can be edited. \"False\" when the SKU has existing sales (successful, shipped, or test transactions)"},"type":{"title":"Type of product (SKU)","enum":["one-time","subscription"],"description":"| type | description |\n|---|---|\n| one-time | single payment |\n| subscription | recurrent payments | "},"price":{"title":"Price","oneOf":[{"title":"Amount of product","description":"Amount of operation","type":"number","format":"double","example":9.99},{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}}]},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"createdAt":{"type":"string","format":"date-time","title":"Date of product create","example":"2020-04-17 13:43:02"},"updatedAt":{"type":"string","format":"date-time","title":"Date of product last update","example":"2020-11-17 13:43:02"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}},"put":{"tags":["Product"],"summary":"Update product (SKU)","operationId":"updateProduct","description":"","parameters":[{"name":"name","in":"path","required":true,"schema":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload of SKU","type":"object","oneOf":[{"title":"Recurring SKU","properties":{"type":{"enum":["subscription"],"description":"Recurring product"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"title":{"title":"Product (SKU) description","type":"string","minLength":3,"maxLength":128,"description":"The product description that will be shown on the payment page","example":"Annual subscription"},"i18n":{"title":"Localized SKU titles","type":"object","description":"Localized SKU titles. Only provided locales will be returned","properties":{"title":{"type":"object","properties":{"de":{"type":"string"},"nl":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"},"ja":{"type":"string"},"zh":{"type":"string"},"es":{"type":"string"},"pt":{"type":"string"},"ar":{"type":"string"}}}}},"active":{"type":"boolean","description":"Indicates whether the SKU is active."},"externalId":{"title":"Merchant SKU ID","description":"Merchant SKU ID","type":"string","minLength":3,"maxLength":36,"example":"7f9s7f9sfs9"},"price":{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}}},"required":["title","type","price","siteId"]},{"title":"One-time SKU","properties":{"type":{"enum":["one-time"],"description":"One-time product"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"i18n":{"title":"Localized SKU titles","type":"object","description":"Localized SKU titles. Only provided locales will be returned","properties":{"title":{"type":"object","properties":{"de":{"type":"string"},"nl":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"},"ja":{"type":"string"},"zh":{"type":"string"},"es":{"type":"string"},"pt":{"type":"string"},"ar":{"type":"string"}}}}},"active":{"type":"boolean","description":"Indicates whether the SKU is active"},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99}},"required":["title","type","siteId","currency","amount"]}]}}}},"responses":{"200":{"description":"Updated","content":{"application/json":{"schema":{"title":"Object to represent SKU","type":"object","properties":{"name":{"title":"Gateway SKU","description":"SKU name that you added when creating SKU","type":"string","minLength":5,"maxLength":36,"example":"TEST_EN"},"siteId":{"title":"Gateway site ID","description":"Gateway site ID (created on the Merchant portal)","type":"string","minLength":5,"maxLength":36,"example":"983759353"},"externalId":{"title":"Merchant site ID","description":"Merchant site ID","type":"string","minLength":3,"maxLength":36,"example":"14253ms92m0as"},"title":{"title":"Product name","description":"Product name displayed on the payment page (3–128 characters)","type":"string","minLength":3,"maxLength":128},"i18n":{"title":"Localized SKU titles","type":"object","description":"Localized SKU titles. Only provided locales will be returned","properties":{"title":{"type":"object","properties":{"de":{"type":"string"},"nl":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"},"ja":{"type":"string"},"zh":{"type":"string"},"es":{"type":"string"},"pt":{"type":"string"},"ar":{"type":"string"}}}}},"active":{"type":"boolean","description":"Indicates whether the SKU is active"},"editable":{"type":"boolean","description":"Indicates whether the SKU can be edited. \"False\" when the SKU has existing sales (successful, shipped, or test transactions)"},"type":{"title":"Type of product (SKU)","enum":["one-time","subscription"],"description":"| type | description |\n|---|---|\n| one-time | single payment |\n| subscription | recurrent payments | "},"price":{"title":"Price","oneOf":[{"title":"Amount of product","description":"Amount of operation","type":"number","format":"double","example":9.99},{"type":"array","items":{"title":"Price","type":"object","properties":{"offset":{"title":"Date offset in days","type":"string","description":"Number of days by how long the transaction will be delayed","maxLength":3,"example":"5d"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"repeat":{"oneOf":[{"type":"boolean","title":"Boolean flag of repeat","description":"Set to <b>false</b> to not repeat the transation, and <b>true</b> - to repeat the transation"},{"title":"Numeric count of repeat","type":"integer","description":"Count of repeats"}]}}}}]},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"createdAt":{"type":"string","format":"date-time","title":"Date of product create","example":"2020-04-17 13:43:02"},"updatedAt":{"type":"string","format":"date-time","title":"Date of product last update","example":"2020-11-17 13:43:02"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/consumer":{"post":{"tags":["Consumer"],"summary":"Create consumer (user)","operationId":"createConsumer","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload of consumer","type":"object","properties":{"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"username":{"title":"Consumer username","description":"Username","type":"string","minLength":1,"maxLength":255},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"birthday":{"title":"Customer's date of birth","type":["null","string"],"description":"Date of birth","example":"Yyyy-mm-dd"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"groupId":{"title":"Consumer group ID","enum":[1,2,3,4,5],"description":"| id | description\n|---|---|\n| 1 | whitelist |\n| 2 | blacklist |\n| 3 | junior |\n| 4 | senior |\n| 5 | expert |"}},"required":["externalId"],"example":{"externalId":"14253ms92m0as","username":"Jonny Sonny","email":"jonny.sonny@google.com","firstName":"Jonny","lastName":"Sonny","birthday":"1987-12-23","country":"USA","groupId":3}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"username":{"title":"Consumer username","description":"Username","type":"string","minLength":1,"maxLength":255},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"birthday":{"title":"Customer's date of birth","type":["null","string"],"description":"Date of birth","example":"Yyyy-mm-dd"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"groupId":{"title":"Consumer group ID","enum":[1,2,3,4,5],"description":"| id | description\n|---|---|\n| 1 | whitelist |\n| 2 | blacklist |\n| 3 | junior |\n| 4 | senior |\n| 5 | expert |"},"blocked":{"title":"Blocked","type":"boolean","description":"Consumer ID blocked"}},"required":["id"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/consumer/{id}":{"get":{"tags":["Consumer"],"summary":"Get consumer (user)","operationId":"getConsumer","description":"","parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"username":{"title":"Consumer username","description":"Username","type":"string","minLength":1,"maxLength":255},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"birthday":{"title":"Customer's date of birth","type":["null","string"],"description":"Date of birth","example":"Yyyy-mm-dd"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"groupId":{"title":"Consumer group ID","enum":[1,2,3,4,5],"description":"| id | description\n|---|---|\n| 1 | whitelist |\n| 2 | blacklist |\n| 3 | junior |\n| 4 | senior |\n| 5 | expert |"},"blocked":{"title":"Blocked","type":"boolean","description":"Consumer ID blocked"}},"required":["id"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}},"put":{"tags":["Consumer"],"summary":"Update consumer (user)","operationId":"changeConsumerGroup","description":"","parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"groupId":{"title":"Consumer group ID","enum":[1,2,3,4,5],"description":"| id | description\n|---|---|\n| 1 | whitelist |\n| 2 | blacklist |\n| 3 | junior |\n| 4 | senior |\n| 5 | expert |"}}}}}},"responses":{"200":{"description":"Updated","content":{"application/json":{"schema":{"title":"Object to represent Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"username":{"title":"Consumer username","description":"Username","type":"string","minLength":1,"maxLength":255},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"birthday":{"title":"Customer's date of birth","type":["null","string"],"description":"Date of birth","example":"Yyyy-mm-dd"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"groupId":{"title":"Consumer group ID","enum":[1,2,3,4,5],"description":"| id | description\n|---|---|\n| 1 | whitelist |\n| 2 | blacklist |\n| 3 | junior |\n| 4 | senior |\n| 5 | expert |"},"blocked":{"title":"Blocked","type":"boolean","description":"Consumer ID blocked"}},"required":["id"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/ips":{"get":{"tags":["Service"],"summary":"Our IP addresses","operationId":"getListOfExternalIps","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent IP list","type":"array","items":{"type":"string"},"example":["52.58.234.180","18.185.38.173","18.185.208.231","18.185.208.83"]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/testPaymentData/{id}":{"get":{"tags":["Test payment data"],"summary":"Get test payment data by ID","operationId":"getTestPaymentDataByID","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Test payment data ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}},"delete":{"tags":["Test payment data"],"summary":"Delete test payment data","operationId":"deleteTestPaymentDataByID","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Test payment data ID"}],"responses":{"201":{"description":"OK"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/testPaymentData/{id}/balance":{"put":{"tags":["Test payment data"],"summary":"Update balance of the test payment data","operationId":"updateBalanceOfTheTestPaymentData","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Update balance payload","type":"object","properties":{"balance":{"type":"integer","description":"Desired balance of the test payment data","minLength":1,"maxLength":6}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/testPaymentData":{"post":{"tags":["Test payment data"],"summary":"Create test payment details","operationId":"createTestPaymentData","requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Create test payment details","type":"object","properties":{"type":{"type":"string","enum":["visa","mastercard","diners club international","jcb","maestro","sepa","discover","unionpay","unionpay (19 digits)"],"description":"Test payment data type","minLength":5,"maxLength":36},"emulate3ds":{"type":"boolean","title":"Emulate 3DS","description":"Set to <b>true</b> to emulate the 3DS flow for this test payment data","example":true},"balance":{"type":"integer","description":"Balance of the test payment details","minLength":1,"maxLength":4},"currency":{"enum":["USD","EUR","GBP"],"description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"allowedIps":{"type":"array","items":{"type":"string"},"description":"Allowed IPs array"},"comment":{"type":"string","title":"Comment","description":"Optional comment for additional context","maxLength":255}},"required":["type","emulate3ds","balance","currency","allowedIps"],"example":{"type":"visa","emulate3ds":"true","balance":"44"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}},"get":{"tags":["Test payment data"],"summary":"Get list of the test payment data","operationId":"getListOfTestPaymentData","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"integer"},"description":"Per page limit"},{"in":"query","name":"type","schema":{"type":"string"},"description":"Type of the test payment data"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/testPaymentData/{id}/block":{"post":{"tags":["Service"],"summary":"Block test payment data","operationId":"blockTestPaymentData","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Test payment data ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/testPaymentData/{id}/unblock":{"post":{"tags":["Test payment data"],"summary":"Unblock test payment data","operationId":"unblockTestPaymentData","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Test payment data ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/testPaymentData/{id}/emulate3ds":{"post":{"tags":["Test payment data"],"summary":"Emulate 3Ds for the test payment data","operationId":"emulate3DsForTestPaymentData","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Test payment data ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Update 3Ds emulation payload","type":"object","properties":{"emulate3ds":{"type":"boolean","example":false,"description":"Set to <b>true</b> to emulate the 3DS flow for this test payment data"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/testPaymentData/{id}/notEmulate3ds":{"post":{"tags":["Test payment data"],"summary":"Not emulate 3Ds for the test payment data","operationId":"notEmulate3DsForTestPaymentData","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Test payment data ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Update 3Ds emulation payload","type":"object","properties":{"emulate3ds":{"type":"boolean","example":false,"description":"Set to <b>true</b> to emulate the 3DS flow for this test payment data"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/antifraud/verification/{phone}":{"get":{"tags":["Verification"],"summary":"Get available channels of code verification","operationId":"getAvailableChannelsOfCodeVerification","parameters":[{"name":"phone","in":"path","schema":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"required":true},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent code verification channels","description":"List of available channels of verification","type":"array","items":{"type":"string"},"example":["sms","telegram","whatsapp"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/antifraud/verification/{channel}/send":{"post":{"tags":["Verification"],"summary":"Send message with verification code","operationId":"sendMessageWithVerificationCode","parameters":[{"name":"channel","in":"path","schema":{"type":"string"},"description":"Channel of message","required":true},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone"],"properties":{"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"from":{"type":"string","minLength":3,"maxLength":16,"example":"Gateway"}}}}}},"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/antifraud/verification/{phone}/{code}":{"get":{"tags":["Verification"],"summary":"Check verification code","operationId":"checkVerificationCode","parameters":[{"name":"phone","in":"path","schema":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"required":true},{"name":"code","in":"path","schema":{"type":"string"},"description":"Verification code","required":true},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Code is valid"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/currency-exchange-rate":{"get":{"tags":["Currency exchange rates"],"summary":"Get list of currency exchange rates","operationId":"getCurrencyExchangeRates","description":"","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"title":"Object to represent currency rate","type":"object","properties":{"iso3":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"usdPerUnit":{"type":"number","format":"double","title":"USD amount per 1 unit"},"unitPerUsd":{"type":"number","format":"double","title":"Amount per 1 USD"}},"example":{"iso3":"EUR","usdPerUnit":0.88,"unitPerUsd":1.13}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/currency-exchange-rate/{iso3}":{"get":{"tags":["Currency exchange rates"],"summary":"Get exchange rate by ISO3","operationId":"getExchangeRateByIso3","description":"","parameters":[{"name":"iso3","in":"path","required":true,"schema":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent currency rate","type":"object","properties":{"iso3":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"usdPerUnit":{"type":"number","format":"double","title":"USD amount per 1 unit"},"unitPerUsd":{"type":"number","format":"double","title":"Amount per 1 USD"}},"example":{"iso3":"EUR","usdPerUnit":0.88,"unitPerUsd":1.13}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/chargeback/{id}/repaidLink":{"get":{"tags":["Service"],"summary":"Get repaid link for chargeback","operationId":"getChargebackIdRepaidLink","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Chargeback transaction ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent payment page URL","type":"object","properties":{"url":{"title":"Redirect URL","type":"string","description":"Gateway payment page URL to which you redirect your user","example":"https://pay.centrobill.com/unique-hash"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/testPaymentData/{id}/allowedIps":{"post":{"tags":["Test payment data"],"summary":"Update allowed IPs","operationId":"updateAllowedIPs","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Test payment data ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Object to represent IP list","type":"array","items":{"type":"string"},"example":["5.18.206.55","122.166.96.83"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent test payment data","type":"object","properties":{"id":{"type":"string","title":"Unique test payment id","description":"Unique test payment ID","example":1234},"type":{"type":"string","title":"Type of the test payment data","description":"Test payment data type","example":"visa"},"emulate3ds":{"type":"boolean","title":"True if test payment data needs to emulate 3Ds process","description":"Set to <b>true</b> to emulate the 3DS or SCA authentication process for this transaction"},"number":{"type":"string","title":"Test payment data","description":"Test payment data","example":"4024007179366348"},"balance":{"type":"integer","title":"Balance of the test payment data","description":"Test payment data balance","example":44},"blocked":{"type":"boolean","description":"Set to <b>true</b> to emulate blocked payment amount","example":false},"allowedIps":{"type":"array","description":"List of allowed IPs","items":{"type":"string"}},"createdAt":{"type":"integer","title":"Date when test payment details were created","description":"Date when test payment details were created","example":"2022-01-27 10:11:39"},"updatedAt":{"type":"integer","title":"Date when test payment details were updated","description":"Date when test payment details were updated","example":"2022-01-27 10:11:39"},"comment":{"type":"string","title":"Comment","description":"Comment for additional context","maxLength":255}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/consumer/{id}/paymentAccounts":{"get":{"tags":["Consumer"],"summary":"List payment account IDs by consumer ID","operationId":"listPaymentaccountIDsByConsumerId","description":"","parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"title":"Object to represent result of 'List payment account IDs' method","type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"title":"Card number","description":"Full card number","type":"string","minLength":12,"maxLength":19},"paymentAccountId":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"brand":{"type":"string","title":"Card brand","example":"visa"},"expirationMonth":{"title":"Card expiration month","description":"The expiry month of the card","type":"string","minLength":2,"maxLength":2},"expirationYear":{"title":"Card expiration year","description":"The expiry year of the card","type":"string","minLength":2,"maxLength":2},"disabled":{"title":"Card status","type":"boolean","description":"Shows whether card is active or inactive."}},"example":[{"method":"card","number":"537541****1917","paymentAccountId":"02a05129-dde6-4e2e-b11c-f9975f630be4","brand":"mastercard","expirationMonth":5,"expirationYear":24,"disabled":false},{"method":"card","number":"400000****0874","paymentAccountId":"59f990b3-3f90-401a-b4b4-09ef5de8dee9","brand":"visa","expirationMonth":"01","expirationYear":"26","disabled":false},{"method":"card","number":"401200****0007","paymentAccountId":"5c11fb2f-6e9a-4c04-98a7-7372801d6281","brand":"visa","expirationMonth":"02","expirationYear":"27","disabled":false},{"method":"card","number":"223344****2176","paymentAccountId":"ae853c41-2d85-4c8a-9a61-3a5daeea311d","brand":"mastercard","expirationMonth":"02","expirationYear":"25","disabled":false},{"method":"card","number":"424242****4242","paymentAccountId":"b327c4cf-9d79-45aa-bdf5-c5243744182b","brand":"visa","expirationMonth":"04","expirationYear":"24","disabled":false},{"method":"card","number":"223344****0243","paymentAccountId":"f06e2cf7-6083-449a-9d95-551321957497","brand":"mastercard","expirationMonth":"02","expirationYear":"26","disabled":false}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/subscription/{id}/paymentAccount":{"put":{"tags":["Subscription"],"summary":"Change payment account for subscription","operationId":"changePaymentAccountForsubscription","description":"","parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Subscription ID","description":"Gateway subscription ID","type":"string","minLength":5,"maxLength":36}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Change payment account for subscription","properties":{"paymentSource":{"title":"Payment source","type":"object","oneOf":[{"title":"Credit card","type":"object","required":["type","number","expirationYear","expirationMonth","cvv"],"properties":{"type":{"enum":["card"]},"number":{"title":"Card number","description":"Full card number","type":"string","minLength":12,"maxLength":19},"expirationYear":{"title":"Card expiration year","description":"The expiry year of the card","type":"string","minLength":2,"maxLength":2},"expirationMonth":{"title":"Card expiration month","description":"The expiry month of the card","type":"string","minLength":2,"maxLength":2},"cvv":{"type":"string","title":"Card security code","description":"The final three digits printed on the back of the card","minLength":3,"maxLength":4},"3ds":{"type":"boolean","title":"Payment should be processed with 3D Secure. True by default","description":"Activate the 3DS or SCA authentication process for this transaction. Set to <b>true</b> by default"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36},"mpiParameters":{"properties":{"authStatus":{"title":"authStatus","type":"string","description":"Authorization status","example":"Y"},"cavv":{"title":"cavv","type":"string","description":"CAVV value","example":"kBMSV/fB8ausrgK8Xem8wIQBeP88"},"eci":{"title":"eci","type":"string","description":"ECI value","example":"02"},"protocolVersion":{"title":"protocolVersion","type":"string","description":"Version of Protocol","example":2},"directoryServerTransactionId":{"title":"directoryServerTransactionId","type":"string","description":"Directory Server Transaction ID","example":"3ba1f2c9-613b-4c00-80b1-ec8869690b26"},"scaExemption":{"title":"scaExemption","description":"SCA exemption","enum":["lowValue","tra","merchantWhitelist","recurringTransaction","trustedBeneficiary","moto"],"example":"lowValue"}}}}},{"title":"Sepa","type":"object","required":["type","iban"],"properties":{"type":{"enum":["sepa"]},"iban":{"type":"string","minLength":5,"maxLength":34,"description":"International bank account number in ISO-13616 format","title":"International bank account number ISO-13616"},"bic":{"title":"Business Identifier Code ISO-9362","description":"Business identifier code (BIC/SWIFT code) in ISO-9362 format","type":"string","minLength":8,"maxLength":11},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"},"mid":{"title":"Process the payment via specified merchant account.","description":"Allows processing transactions via the specified Merchant account ID (MID)","type":"string","minLength":2,"maxLength":36}}},{"title":"Token of tokenized card data","type":"object","required":["type","value"],"properties":{"type":{"enum":["token"]},"value":{"type":"string","description":"Token you have received after using <b>../tokenize</b> or <b>../tokenizeWithPaymentAccountId</b>","minLength":5,"maxLength":36},"3ds":{"type":"boolean","title":"Payment should be processed with 3D Secure. Set to <b>true</b> by default","description":"Activate the 3DS or SCA authentication process for this transaction. Set to <b>true</b> by default"},"emulateCode":{"title":"Emulate transaction's decline codes. For example, 5003 will throw \"Invalid merchant\" decline. See full declines list below in responses under payment object.","description":"Emulate a specific decline code for the transaction. Follow the <a href=\"https://readme.centrobill.com/docs/decline-codes\">link</a> for the list of decline codes","type":"string","minLength":4,"maxLength":6,"example":"5003"}}}]},"consumer":{"title":"Consumer","type":"object","required":["id","ip"],"properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"},"ip":{"title":"IP address","description":"IP address","type":"string","minLength":1,"maxLength":16},"userAgent":{"title":"Browser user-agent","type":"string","description":"Consumer's consumer agent <span style=\"color:red\">Required for 3DS transactions</span>","maxLength":255},"deviceId":{"title":"Exodentity device ID","type":"string","description":"Exodentity device ID","maxLength":1024}}}},"required":["paymentSource","consumer"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent payment result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["redirect","charge"],"example":"charge","description":"|  action name | description |\n|---|---|\n| charge | Card will be charged immediately.  |\n| redirect | Consumer should be redirected to url for second step |","title":"The default action that should be undertaken"},"url":{"type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"URL"},"qrCode":{"type":"string","example":"00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381","description":"String to convert to a QR code"},"mode":{"type":"string","enum":["sale","auth"],"title":"Payment mode","description":"Payment mode","example":"sale"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99},"orderId":{"type":"string","description":"Gateway transaction ID","minLength":5,"maxLength":36,"example":"235324530"},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"402400****6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"disabled":{"type":"boolean","description":"If set to <b>true</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/disablepaymentaccountforquicksale\">deactivated for quick sale transactions</a>. If set to <b>false</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/enablepaymentaccountforquicksale\">activated for quick sale transactions</a>. Refer to the appropriate methods to disable or enable the <b>paymentAccountId</b>."}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"subscription":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Subscription status","description":"Subscription status","example":"active","nullable":true},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","description":"Expected date of renewal","example":"2020-04-17 13:43:02","nullable":true},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","description":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0,"nullable":true}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}},"callbacks":{"paymentEvent":{"{$request.body.url.ipnUrl}":{"summary":"Payment status callback","post":{"summary":"Payment status callback","operationId":"paymentStatusCallback","requestBody":{"content":{"application/json":{"schema":{"title":"Object to represent payment result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["redirect","charge"],"example":"charge","description":"|  action name | description |\n|---|---|\n| charge | Card will be charged immediately.  |\n| redirect | Consumer should be redirected to url for second step |","title":"The default action that should be undertaken"},"url":{"type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"URL"},"qrCode":{"type":"string","example":"00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381","description":"String to convert to a QR code"},"mode":{"type":"string","enum":["sale","auth"],"title":"Payment mode","description":"Payment mode","example":"sale"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99},"orderId":{"type":"string","description":"Gateway transaction ID","minLength":5,"maxLength":36,"example":"235324530"},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"402400****6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"disabled":{"type":"boolean","description":"If set to <b>true</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/disablepaymentaccountforquicksale\">deactivated for quick sale transactions</a>. If set to <b>false</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/enablepaymentaccountforquicksale\">activated for quick sale transactions</a>. Refer to the appropriate methods to disable or enable the <b>paymentAccountId</b>."}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"subscription":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Subscription status","description":"Subscription status","example":"active","nullable":true},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","description":"Expected date of renewal","example":"2020-04-17 13:43:02","nullable":true},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","description":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0,"nullable":true}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}}}}}},"responses":{"200":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"201":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully\n"},"202":{"description":"Your server implementation should return this HTTP status code\nif the data was received successfully          \n"}}}}}}}},"/paymentAccount/{paymentAccountId}/disable":{"post":{"tags":["Service"],"summary":"Disable payment account for quick-sale","operationId":"disablePaymentAccountForQuickSale","parameters":[{"name":"paymentAccountId","in":"path","description":"ID of the encoded user payment details","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"title":"Object to represent enabled/disabled account for quick-sale","x-stoplight":{"id":"d8613ba0a2944"},"type":"object","properties":{"paymentAccountId":{"type":"string","title":"Payment account ID","example":"ae853c41-2d85-4c8a-9a61-3a5daeea311d"}}}}}}}}},"/paymentAccount/{paymentAccountId}/enable":{"post":{"tags":["Service"],"summary":"Enable payment account for quick-sale","operationId":"enablePaymentAccountForQuickSale","parameters":[{"name":"paymentAccountId","in":"path","description":"ID of the encoded user payment details","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"title":"Object to represent enabled/disabled account for quick-sale","x-stoplight":{"id":"d8613ba0a2944"},"type":"object","properties":{"paymentAccountId":{"type":"string","title":"Payment account ID","example":"ae853c41-2d85-4c8a-9a61-3a5daeea311d"}}}}}}}}},"/payment/applePaySession":{"post":{"tags":["Service"],"summary":"Get ApplePay session","operationId":"getApplePaySession","requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Payload to get ApplePay Session ID","type":"object","properties":{"domain":{"title":"Domain name (without protocol)","type":"string","minLength":5,"maxLength":36,"description":"Website domain name without http(s) protocol","example":"pay.google.com"}},"required":["domain"]}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"title":"Object to represent successful get ApplePaySession","type":"object","properties":{"session":{"title":"ApplePay session","type":"string","description":"ApplePay session ID"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/consumer/{id}/limit":{"get":{"tags":["Consumer"],"summary":"Get limit of consumer","operationId":"getLimit","description":"","parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36}},{"name":"X-Request-ID","in":"header","description":"Unique ID of request","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent 200 response for limit","type":"object","properties":{"limit":{"type":"number","title":"Limit","default":0},"balance":{"type":"number","title":"Balance","default":0},"nextQuickSaleStatus":{"type":"string","title":"Next quick-sale status","default":"OK"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"object"},"example":{"parameterName":"Parameter is invalid or missing"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Forbidden"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/transaction/{id}/ipn":{"get":{"summary":"Get IPN for transaction ID","operationId":"getTransactionIdIpn","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Transaction ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent result of 'Get transaction/order ID IPN' methods","type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"url","description":"URL where the IPN was sent","example":"https://merchant.example.com/ipn"},"request":{"type":"string","description":"Request body of the IPN"},"response":{"type":"string","description":"Response returned by the merchant's endpoint"},"orderId":{"type":"string","description":"Order ID of the payment associated with the IPN","example":"order_abc123"},"transactionId":{"type":"string","description":"Transaction ID of the payment associated with the IPN","example":"txn_xyz789"},"execTime":{"type":"string","description":"Unix timestamp of the IPN delivery attempt","example":"1637063718"},"httpCode":{"type":"string","description":"HTTP status code","example":"200"},"error":{"type":"string","nullable":true,"description":"Error message, if any (e.g., timeout)","example":"timeout"},"attemptNumber":{"type":"integer","description":"Number of the delivery attempt","example":2}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}},"post":{"tags":["Service"],"summary":"Create IPN for transaction ID","operationId":"createTransactionIdIpn","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Transaction ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"title":"IPN URL","type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"The Instant payment notification (aka IPN or callback) will be sent to this URL"}}}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"content":{"application/json":{"schema":{"title":"Object to represent payment result","type":"object","properties":{"payment":{"type":"object","properties":{"code":{"title":"Payment code","enum":["0","1001","1002","5000","5001","5003","5004","5005","5006","5007","5008","5010","5012","5013","5014","5015","5016","5019","5030","5041","5043","5046","5051","5053","5054","5055","5057","5058","5059","5061","5062","5063","5065","5070","5075","5078","5079","5080","5082","5085","5086","5091","5093","5094","5096","5099","5220","5221","5222","5223","5224","5225","5226","5227","5228","5300"],"description":"| code | description\n|---|---|\n| 0 | success |\n| 1001 | Underpayment. Paid amount is less than the requested amount |\n| 1002 | Overpayment. Paid amount is greater than the requested amount |\n| 5000 | General bank decline |\n| 5001 | Refer to Issuer |\n| 5003 | Invalid merchant |\n| 5004 | Pick up card(no fraud) |\n| 5005 | Do not honor |\n| 5006 | Payment could not be authorised |\n| 5007 | Pick up card, special condition (fraud account) |\n| 5008 | Reattempt not permitted |\n| 5010 | Partial approval |\n| 5012 | Invalid transaction |\n| 5013 | Invalid amount |\n| 5014 | Invalid card number |\n| 5015 | No such issuer |\n| 5016 | Invalid cardholder name |\n| 5019 | Re-enter transaction |\n| 5030 | Format error |\n| 5041 | Lost card, pick up (fraud account) |\n| 5043 | Stolen card, pick up (fraud account) |\n| 5046 | Closed account |\n| 5051 | Insufficient funds |\n| 5053 | Wrong expiration date |\n| 5054 | Expired card |\n| 5055 | Invalid PIN |\n| 5057 | Transaction not permitted - Card |\n| 5058 | Transaction not permitted - Terminal |\n| 5059 | Suspected fraud |\n| 5061 | Withdrawal amount limit exceeded |\n| 5062 | Invalid service code, restricted |\n| 5063 | Security Violation |\n| 5065 | Activity limit exceeded |\n| 5070 | PIN data required |\n| 5075 | PIN tries exceeded |\n| 5078 | Invalid/nonexistent account specified (general) |\n| 5079 | Blocked, first used |\n| 5080 | Credit issuer unavailable |\n| 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted |\n| 5085 | No reason to decline |\n| 5086 | Cannot verify PIN |\n| 5091 | Issuer or switch is unavailable |\n| 5093 | Violation, cannot complete |\n| 5094 | Duplicate transaction |\n| 5096 | System error |\n| 5099 | Expired payment |\n| 5220 | Authentication failed by card issuer |\n| 5221 | Authentication is unavailable at the moment |\n| 5222 | Payment attempt failed or canceled |\n| 5223 | Rejected authentication by the issuer  |\n| 5224 | Card not enrolled |\n| 5225 | Attempts processing performed |\n| 5226 | Card account number not found in the card ranges from the Directory Server |\n| 5227 | 3D Secure SCA required |\n| 5228 | Verification not completed, timeout |\n| 5300 | BIC is not SDD compliant |\n| 5031 | Invalid cardholder address |\n| 5032 | Invalid phone number |\n| 5034 | Invalid currency |"},"description":{"title":"Processing details","description":"Processing details","type":"string","maxLength":128,"example":"APPROVED"},"action":{"type":"string","enum":["redirect","charge"],"example":"charge","description":"|  action name | description |\n|---|---|\n| charge | Card will be charged immediately.  |\n| redirect | Consumer should be redirected to url for second step |","title":"The default action that should be undertaken"},"url":{"type":"string","format":"url","example":"https://google.com/oijhflsfs9","description":"URL"},"qrCode":{"type":"string","example":"00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381","description":"String to convert to a QR code"},"mode":{"type":"string","enum":["sale","auth"],"title":"Payment mode","description":"Payment mode","example":"sale"},"status":{"type":"string","enum":["success","fail","pending"],"title":"Payment status","description":"Payment status","example":"success"},"amount":{"title":"Amount of operation","description":"Amount of operation","type":"number","format":"double","example":9.99},"currency":{"title":"Currency","description":"Currency of operation in ISO3 format","format":"ISO3","example":"USD"},"amountUsd":{"title":"Amount of operation in USD","description":"Amount of operation in USD","type":"number","format":"double","example":9.99},"orderId":{"type":"string","description":"Gateway transaction ID","minLength":5,"maxLength":36,"example":"235324530"},"transactionId":{"title":"Payment transaction ID","description":"Payment transaction ID","type":"string","minLength":5,"maxLength":36,"example":"12345"},"descriptor":{"type":"string","description":"Payment descriptor","example":"centrohelp.com"},"source":{"type":"object","properties":{"method":{"title":"Payment method","description":"Payment method","enum":["card","applepay","sepa","sofortbanking","ideal","eps","mybank","bancontact","giropay","przelewy24","onlinebanking","skrill","clickandbuy","paypal","pix","boleto","pps","gash","crypto","paygarden","alipay","wechat","unionpay_wallet","voucher","paysafecard","ukash","safeklick","sms","x1","lotericas","picpay","deposit_express","payid","spei","oxxo","codi","todito","banktransfer","cashpayment","pse","efecty","tpaga","pago46","khipu","multibanco","bncr","mbway","papara","havale","webpay_chile","banktransferChile","khipu","mach"],"example":"card"},"number":{"type":"string","title":"Card/account number","description":"Card/account number","example":"402400****6348"},"brand":{"type":"string","title":"Brand of account (if available)","description":"Account brand (if available)","example":"visa"},"bankName":{"type":"string","title":"Bank name","description":"Bank name","example":"BENDIGO AND ADELAIDE BANK, LTD"},"bankCountry":{"type":"string","title":"Bank country","description":"Bank country","example":"AUS"},"expirationMonth":{"type":"string","title":"Card expiration month (if available)","description":"Card expiration month (if available)","example":2},"expirationYear":{"type":"string","title":"Card expiration year (if available)","description":"Card expiration year (if available)","example":27},"paymentAccountId":{"type":"string","description":"ID of the encoded user payment details","format":"uuid","example":"d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"},"disabled":{"type":"boolean","description":"If set to <b>true</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/disablepaymentaccountforquicksale\">deactivated for quick sale transactions</a>. If set to <b>false</b>, the <b>paymentAccountId</b> is <a href=\"https://readme.centrobill.com/reference/enablepaymentaccountforquicksale\">activated for quick sale transactions</a>. Refer to the appropriate methods to disable or enable the <b>paymentAccountId</b>."}}}}},"consumer":{"title":"Consumer","type":"object","properties":{"id":{"title":"Gateway consumer ID","description":"Gateway consumer ID (user ID)","type":"string","minLength":5,"maxLength":36},"externalId":{"title":"Merchant consumer ID","description":"Merchant consumer ID (user ID)","type":"string","minLength":3,"maxLength":64,"example":"14253ms92m0as"},"email":{"title":"Consumer email","description":"Email address","type":"string","maxLength":100,"format":"email","example":"jonny.sonny@google.com"},"firstName":{"title":"Consumer first name","description":"First name","type":"string","minLength":1,"maxLength":32},"lastName":{"title":"Consumer last name","description":"Last name","type":"string","minLength":1,"maxLength":32},"phone":{"title":"Consumer's phone number","description":"Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).","type":"string","minLength":7,"maxLength":16,"pattern":"^\\+?[1-9][0-9]*$","example":"+1987654320"},"country":{"title":"Consumer's country","description":"Country name in ISO3 format","type":"string","format":"ISO3","example":"GBR"},"state":{"title":"Consumer's state","description":"State name","type":"string","minLength":1,"maxLength":32},"city":{"title":"Consumer city","description":"City name","type":"string","minLength":1,"maxLength":50},"zip":{"title":"Zip code","description":"Postal code","type":"string","minLength":1,"maxLength":16,"example":"36101"}},"required":["id"]},"subscription":{"title":"Object to represent subscription","type":"object","properties":{"id":{"title":"Subscription ID","description":"Subscription ID","type":"string","minLength":5,"maxLength":36},"status":{"enum":["active","canceled"],"title":"Subscription status","description":"Subscription status","example":"active","nullable":true},"renewalDate":{"type":"string","format":"date-time","title":"Expected date of renewal","description":"Expected date of renewal","example":"2020-04-17 13:43:02","nullable":true},"cancelDate":{"type":"string","format":"date-time","title":"Expected date of cancel","description":"Expected date of cancel","example":"2020-11-17 13:43:02","nullable":true},"cycle":{"type":"number","title":"A sequential number of recurring payments in a subscription","description":"| value | description |\n|---|---|\n| 0 | subscription has an initial payment |\n| n | subscription has n recurrent payments |","example":0,"nullable":true}}},"metadata":{"title":"Metadata","type":"object","description":"Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal","example":{"foo":"bar"}},"timestamp":{"title":"Timestamp","type":"object","properties":{"dateTime":{"title":"Date & time","type":"string","format":"date-time","example":"2020-04-17 13:43:02"},"timezone":{"title":"Time zone","type":"string","format":"UTC","example":"UTC+02.00"},"unixTime":{"title":"Unix timestamp","type":"string","example":"1637063718"}}}}}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/order/{id}/ipn":{"get":{"summary":"Get IPN for order ID","operationId":"getOrderIdIpn","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Order ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent result of 'Get transaction/order ID IPN' methods","type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"url","description":"URL where the IPN was sent","example":"https://merchant.example.com/ipn"},"request":{"type":"string","description":"Request body of the IPN"},"response":{"type":"string","description":"Response returned by the merchant's endpoint"},"orderId":{"type":"string","description":"Order ID of the payment associated with the IPN","example":"order_abc123"},"transactionId":{"type":"string","description":"Transaction ID of the payment associated with the IPN","example":"txn_xyz789"},"execTime":{"type":"string","description":"Unix timestamp of the IPN delivery attempt","example":"1637063718"},"httpCode":{"type":"string","description":"HTTP status code","example":"200"},"error":{"type":"string","nullable":true,"description":"Error message, if any (e.g., timeout)","example":"timeout"},"attemptNumber":{"type":"integer","description":"Number of the delivery attempt","example":2}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Unauthorized`"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Not Found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/blacklist/status":{"post":{"tags":["Consumer"],"summary":"Set status (blacklist)","operationId":"setStatus","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Type of identifier","enum":["email","card","accountNumber","consumer","ip","phone"]},"value":{"type":"string","description":"Value corresponding to the identifier type"}},"required":["name","value"]}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent response for set status (blacklist)","description":"Status of the selected identifier","type":"object","properties":{"name":{"type":"string","description":"Type of identifier"},"value":{"type":"string","description":"Identifier value (e.g., email)","example":"jonnysonny@example.com"},"systemId":{"type":"string","description":"System ID"},"blocked":{"type":"boolean","description":"Whether the identifier is currently blocked","example":false},"message":{"type":"string","description":"Action performed (e.g., \"block\" or \"unblock\")","example":"unblock"},"author":{"type":"string","description":"Name of the author who performed the action","example":"Jonny test"},"timestamp":{"type":"integer","format":"int64","description":"Unix timestamp of the action","example":1744817695}},"required":["blocked","message","author","timestamp","name","value"]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/blacklist/block":{"post":{"tags":["Consumer"],"summary":"Block user identifier (email, card, etc.)","operationId":"blacklistBlock","requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Blacklist identifiers","type":"object","properties":{"name":{"type":"string","description":"Type of identifier to block","enum":["email","card","accountNumber","consumer","ip","phone"],"example":"email"},"value":{"type":"string","description":"Identifier value (e.g., email). Must match the <b>name</b> parameter type  (e.g., if <b>name</b> is 'email', provide an email address here)","example":"jonnysonny@example.com"},"expiredAt":{"type":"string","format":"date-time","nullable":true,"description":"Optional expiration time for the block","example":"2025-12-31T23:59:59Z"},"blockRelatedItems":{"type":"boolean","description":"Block all related data associated with the provided identifier under the <b>value</b> parameter","example":false},"message":{"type":"string","description":"Note or reason for the block","example":"Suspicious activity"},"author":{"type":"string","description":"Author of the block request","example":"admin_user"},"systemId":{"type":"string","description":"Merchant system ID","example":193},"bin":{"type":"string","description":"Bank Identification Number (for card blocks)","example":"411111"},"last4":{"type":"string","description":"Last four card digits (for card blocks)","example":"1111"}},"required":["name","value","message","author"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent response for blacklist (block/unblock)","type":"object","properties":{"name":{"type":"string","description":"Identifier type","enum":["email","card","accountNumber","consumer","ip","phone"],"example":"email"},"value":{"type":"string","description":"The actual value of the identifier (e.g., email address)","example":"jonnysonny@example.com"},"systemId":{"type":"integer","description":"Merchant system ID","example":193},"blocked":{"type":"boolean","description":"Whether the identifier is currently blocked","example":true},"message":{"type":"string","description":"Note or reason for the block","example":"Suspicious activity"},"timestamp":{"type":"integer","format":"int64","description":"Unix timestamp when the block was applied","example":1746457103}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}},"/blacklist/unblock":{"post":{"tags":["Consumer"],"summary":"Unblock user identifier (email, card, etc.)","operationId":"unblockBlacklist","requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Blacklist identifiers","type":"object","properties":{"name":{"type":"string","description":"Type of identifier to block","enum":["email","card","accountNumber","consumer","ip","phone"],"example":"email"},"value":{"type":"string","description":"Identifier value (e.g., email). Must match the <b>name</b> parameter type  (e.g., if <b>name</b> is 'email', provide an email address here)","example":"jonnysonny@example.com"},"expiredAt":{"type":"string","format":"date-time","nullable":true,"description":"Optional expiration time for the block","example":"2025-12-31T23:59:59Z"},"blockRelatedItems":{"type":"boolean","description":"Block all related data associated with the provided identifier under the <b>value</b> parameter","example":false},"message":{"type":"string","description":"Note or reason for the block","example":"Suspicious activity"},"author":{"type":"string","description":"Author of the block request","example":"admin_user"},"systemId":{"type":"string","description":"Merchant system ID","example":193},"bin":{"type":"string","description":"Bank Identification Number (for card blocks)","example":"411111"},"last4":{"type":"string","description":"Last four card digits (for card blocks)","example":"1111"}},"required":["name","value","message","author"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Object to represent response for blacklist (block/unblock)","type":"object","properties":{"name":{"type":"string","description":"Identifier type","enum":["email","card","accountNumber","consumer","ip","phone"],"example":"email"},"value":{"type":"string","description":"The actual value of the identifier (e.g., email address)","example":"jonnysonny@example.com"},"systemId":{"type":"integer","description":"Merchant system ID","example":193},"blocked":{"type":"boolean","description":"Whether the identifier is currently blocked","example":true},"message":{"type":"string","description":"Note or reason for the block","example":"Suspicious activity"},"timestamp":{"type":"integer","format":"int64","description":"Unix timestamp when the block was applied","example":1746457103}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"Object to represent error","type":"object","properties":{"message":{"type":"string","title":"Message of error","default":"Internal server error"}}}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","name":"Authorization","in":"header"}}}}