# Payment processing completed

Publish details of a new processed payment.

Endpoint: POST paymentq
Version: 1.0.106
Security: SignatureAuth

## Request fields (application/json):

  - `id` (string)
    Payment Id
    Example: "91d27876e87f4b22b3ecd53924bf973d"

  - `referenceId` (string)
    referenceId from payment request
    Example: "payment-123"

  - `created` (string)
    Date and time when this payment was created, in UTC time zone
    Example: "2030-12-25T10:11:12"

  - `paymentType` (string)
    Payment Type
    Enum: "DEPOSIT", "WITHDRAWAL", "REFUND"

  - `state` (string)
    Payment State
    Enum: "CHECKOUT", "PENDING", "AUTHORIZED", "CANCELLED", "DECLINED", "COMPLETED"

  - `description` (string)
    Description of the transaction
    Example: "Deposit via TEST shop"

  - `parentPaymentId` (string)
    Initial transaction Id from payment request
    Example: "91d27876e87f4b22b3ecd53924bf973d"

  - `paymentMethod` (string)
    Payment Method
    Enum: "AHLPAY", "ALFAKIT", "ALFAMART", "ALYCEPAY", "APPLEPAY", "ARI10", "ASTROPAY", "B2BINPAY", "BANCONTACT", "BANKTRANSFER", "BANKTRANSFER_AR", "BANKTRANSFER_BO", "BANKTRANSFER_BR", "BANKTRANSFER_CL", "BANKTRANSFER_CO", "BANKTRANSFER_CR", "BANKTRANSFER_EC", "BANKTRANSFER_GT", "BANKTRANSFER_HN", "BANKTRANSFER_MX", "BANKTRANSFER_PA", "BANKTRANSFER_PE", "BANKTRANSFER_TR", "BANKTRANSFER_UY", "BASIC_CARD", "BASIC_CARD_HPP", "BILLLINE", "BINANCE_PAY", "BIOPAGO", "BIZUM", "BKASH", "BLIK", "BOLETO", "BRITE", "BYBIT_PAY", "CASH", "CASHLIB", "CHEK", "CIP", "CLICK", "CODI", "CRYPTO", "CUP", "DANA", "DPOPAY", "DRAGON_PAY", "EASYPAISA", "EFECTY", "EFT", "EMANAT", "ENAIRA", "EPAY_BG", "EPS", "EXTERNAL_HPP", "FAWRY", "FINRAX", "FLEXEPIN", "FPS", "FPX", "FUPS", "GATE8TRANSACT", "GATEIQ", "GCASH", "GIROPAY", "GOOGLEPAY", "GOPAY", "GPAY_IN", "HAVALE", "HAYDIPAY", "HAYHAY", "HELP2PAY", "HITES", "IDEAL", "IMPS", "INAI", "INRPAY", "INTERAC", "INTERAC_ACH", "INTERAC_ETO", "INTERAC_RTO", "JAZZCASH", "JETONCASH", "JETONWALLET", "KAKAOPAY", "KBZ", "KESSPAY", "KHIPU", "KLAP_EFECTIVO", "KLAP_TRANSFERENCIA", "KLARNA", "LOCALPAYMENT", "M10", "MACH", "MACROPAY", "MBWAY", "MEFETE", "MERCADOPAGO", "MIFINITY", "MISTERCASH", "MOBILE_COMMERCE", "MOBILE_MONEY", "MOLLIE", "MOMOPAY_RW", "MOMOPAY_VN", "MONERCHY", "MONETIX", "MONEYTOLIA", "MONNET", "MPAY", "MPESA", "MUCHBETTER", "MULTIBANCO", "MYBANK", "MYPAYZ", "N26", "NAGAD", "NAVERPAY", "NEFT", "NEOSURF", "NEQUI", "NETBANKING", "NETELLER", "NGENIUS", "NODA", "NODA_REVOLUT", "OMNIMATRIX", "ONEVOUCHER", "ONLINE_BANKING", "OPEN_BANKING", "OPENPAYD", "OPTIMONEY", "OVO", "OXXO", "P24", "P2P_ACCESS", "P2P_CARD", "P2P_CARD_HUMO", "P2P_CARD_UZCARD", "P2P_CROSS_BORDER", "P2P_EMANAT", "P2P_IBAN", "P2P_KAPITAL", "P2P_M10", "P2P_MOBILE", "P2P_SBP", "P2P_UPI", "PAGO_MOVIL", "PAGO_MOVIL_INST", "PAGO46", "PAGOEFECTIVO", "PAGOFACIL", "PAPARA", "PAPEL", "PARAM", "PARATIM", "PARAZULA", "PAROLAPARA", "PAY_BY_LINK", "PAY2PLAY", "PAYCASH", "PAYCELL", "PAYCO_TR", "PAYDO_WALLET", "PAYFIX", "PAYFUN", "PAYID", "PAYMAXIS", "PAYMAYA", "PAYNOW", "PAYOUT_NONSEPA_REQUEST", "PAYOUT_SEPA_BATCH", "PAYPAL", "PAYPAY", "PAYPO", "PAYPORT", "PAYRETAILERS", "PAYSAFECARD", "PAYSAFECASH", "PAYSHOP", "PAYTM", "PEC", "PEP", "PERFECTMONEY", "PG_PARA", "PHONEPE", "PIASTRIX", "PICPAY", "PIX", "POLI", "POPY", "POPY_PARA", "PREPAID_CARD", "PROMPTPAY", "PSE", "PUNTOPAGO", "PUSH", "QR", "QRIS", "RAPIDTRANSFER", "RAPIPAGO", "REVOLUT", "ROCKET", "RTGS", "RUBPAY", "SBERPAY", "SBP", "SBP_CROSS_BORDER", "SEPA", "SERVIFACIL", "SHOPEEPAY", "SIPAY", "SKRILL", "SOFORT", "SOFT2PAY", "SPEI", "SPOYNT", "STICPAY", "SWISH", "TED", "TINK", "TOSLA", "TRANSFIYA", "TRUEMONEY", "TRUSTLY", "TRUSTPAYMENTS", "UPI", "USSD", "VIETTEL", "VIRTUAL_ACCOUNT", "VNPAY_QR", "VOLT", "VOUCHERRY", "VOUCHSTAR", "WAVE", "WEBPAY", "WISE", "XANPAY", "XINPAY", "YAPE", "YAPILY", "ZALO", "ZIMPLER", "ZIPAY", "ZOTAPAY"

  - `paymentMethodDetails` (object)

  - `paymentMethodDetails.customerAccountNumber` (string)
    Customer account Id in external system or masked card PAN
    Example: "400000***0002"

  - `paymentMethodDetails.cardToken` (string)
    Card token which can be used instead of full card number (for BASIC_CARD payment method only)
    Example: "3529d42227424875af8722cbf54d7073"

  - `paymentMethodDetails.cardholderName` (string)
    Cardholder name (for BASIC_CARD payment method only)
    Example: "John Doe"

  - `paymentMethodDetails.cardExpiryMonth` (string)
    Card expiration month (for BASIC_CARD payment method only)
    Example: "01"

  - `paymentMethodDetails.cardExpiryYear` (string)
    Card expiration year (for BASIC_CARD payment method only)
    Example: "2030"

  - `paymentMethodDetails.cardBrand` (string)
    Card brand (for BASIC_CARD payment method only)
    Enum: "AMEX", "DINERS", "DISCOVER", "JCB", "MAESTRO", "MASTERCARD", "MIR", "RUPAY", "UNIONPAY", "VISA", "HUMO", "VERVE", "TROY", "UNKNOWN"

  - `paymentMethodDetails.cardIssuingCountryCode` (string)
    Card issuing country code (for BASIC_CARD payment method only)
    Example: "CY"

  - `amount` (number)
    Amount sent to the payment provider
    Example: 11.12

  - `currency` (string)
    Currency sent to the payment provider
    Example: "EUR"

  - `customerAmount` (number)
    Amount from payment request. Filled only if the request currency differs from the currency sent to the payment provider.
    Example: 15

  - `customerCurrency` (string)
    Currency from payment request. Filled only if it differs from the currency sent to the payment provider.
    Example: "USD"

  - `redirectUrl` (string)
    URL to redirect the customer
    Example: "http://start/payment/6ccaa03cb2c242a68ce332f38fedfad7"

  - `errorCode` (string)
    Check 'Error Codes' section for details
    Example: "4.01"

  - `errorMessage` (string)
    Check 'Error Codes' section for details
    Example: "Insufficient Funds"

  - `externalResultCode` (string)
    Result code from external provider
    Example: "03"

  - `customer` (object)

  - `customer.referenceId` (string)
    Id of the customer assigned by Merchant
    Example: "customer_123"

  - `customer.citizenshipCountryCode` (string)
    Customer country of citizenship
    Example: "AU"

  - `customer.firstName` (string)
    Example: "John"

  - `customer.lastName` (string)
    Example: "Smith"

  - `customer.dateOfBirth` (string)
    Example: "2001-12-03"

  - `customer.email` (string)
    Email address of the customer
    Example: "my@email.com"

  - `customer.phone` (string)
    International phone number of the customer, without the '+'. Use a space as a separator between the dialing country code and local phone number.
    Example: "357 123123123"

  - `customer.locale` (string)
    Customer preferred display language
    Example: "ru"

  - `customer.accountNumber` (string)
    Customer account number in the provider's system. Used for some types of withdrawals.

  - `customer.accountName` (string)
    Customer account name in the provider's system. Used for some types of withdrawals.

  - `customer.accountType` (string)
    Account Type
    Enum: "SAVINGS", "CHECKING"

  - `customer.bank` (string)
    Customer bank name. Used for some types of withdrawals.

  - `customer.bankCode` (string)
    Customer bank code. Used for some types of withdrawals.

  - `customer.bankBranch` (string)
    Customer bank branch name. Used for some types of withdrawals.

  - `customer.bankBranchCode` (string)
    Customer bank branch code. Used for some types of withdrawals.

  - `customer.documentType` (string)
    Document Type
    Enum: "AR_CDI", "AR_PP", "AR_CUIL", "AR_CUIT", "AR_DNI", "AR_OTRO", "BO_CEX", "BO_CI", "BO_NIT", "BO_OD", "BO_PP", "BR_CNPJ", "BR_CPF", "BR_PP", "CL_CE", "CL_CI", "CL_ID", "CL_OTRO", "CL_PP", "CL_RUN", "CL_RUT", "CL_TIN", "CO_CC", "CO_CE", "CO_DL", "CO_DNI", "CO_NE", "CO_NIT", "CO_PP", "CO_SS", "CO_TI", "CO_TIN", "CR_CDI", "EC_CC", "EC_DNI", "EC_PP", "EC_RUC", "GT_CUI", "GT_DPI", "GT_NIT", "IN_DL", "IN_ID", "IN_UID", "MX_CRI", "MX_CURP", "MX_IFE", "MX_PP", "MX_RFC", "MX_TIN", "PA_CIP", "PE_CE", "PE_CPP", "PE_DNI", "PE_FRC", "PE_ID", "PE_OTRO", "PE_PP", "PE_RUC", "PE_TIN", "UK_PP", "UK_NIC", "UK_DL", "UK_BTI", "UK_TIN", "UY_CI", "UY_RUT", "VN_TIN"

  - `customer.documentNumber` (string)
    An identifier for the customer assigned by a government authority

  - `customer.routingGroup` (string)
    Identify the customer as belonging to a specific group that is used for routing
    Example: "VIP"

  - `customer.kycStatus` (boolean)
    Indicates whether the customer has passed KYC verification
    Example: true

  - `customer.paymentInstrumentKycStatus` (boolean)
    Indicates whether the payment instrument (usually the card number) has passed KYC verification
    Example: true

  - `customer.dateOfFirstDeposit` (string)
    Date of the first deposit from the customer
    Example: "2021-01-01"

  - `customer.depositsAmount` (integer)
    How much the customer has deposited, in base currency
    Example: 5000

  - `customer.withdrawalsAmount` (integer)
    How much the customer has withdrawn, in base currency
    Example: 1000

  - `customer.depositsCnt` (integer)
    How many times the customer made a deposit
    Example: 5000

  - `customer.withdrawalsCnt` (integer)
    How many times the customer made a withdrawal
    Example: 1000

  - `billingAddress` (object)
    Customer's billing address

  - `billingAddress.addressLine1` (string)
    Line 1 of the address (e.g., Number, street, etc)
    Example: "7, Sunny street"

  - `billingAddress.addressLine2` (string)
    Line 2 of the address (e.g., Suite, apt)
    Example: "Office 3"

  - `billingAddress.city` (string)
    City name
    Example: "Limassol"

  - `billingAddress.countryCode` (string)
    2-character IS0-3166-1 country code
    Example: "CY"

  - `billingAddress.postalCode` (string)
    Postal code
    Example: "4141"

  - `billingAddress.state` (string)
    State code
    Example: "CA"

  - `startRecurring` (boolean)
    Indicates whether this payment has started a recurring chain

  - `preAuth` (boolean)
    Indicates whether this is a Pre-Authorization request (for 2-phase deposit)

  - `recurringToken` (string)
    Token that can be used to continue the recurring chain

  - `terminalName` (string)
    The name of the provider that was used to process this payment

  - `externalFeeAmount` (number)
    Provider fee. Filled only if supported by the provider.
    Example: 15

  - `externalFeeCurrency` (string)
    Provider fee currency. Filled only if supported by the provider.
    Example: "USD"


## Response 200 fields