Payments
...
Transaction mgmt APIs
Push transactions
1 min
{ "name" "endpoint /api/transaction", "method" "get", "url" "https //pushtopaystaging crbnj net/api/transaction", "description" "returns a list of transactions, and their details, for payments sent from a merchant to a payee ", "tab" "examples", "examples" { "languages" \[ { "id" "r hes0bqtzmvil917efq5", "language" "curl", "code" "curl x\nget \n header 'accept application/json' \n header 'authorization bearer {xxx}'\n'https //pushtopaystaging crbnj net/api/transaction'", "customlabel" "" } ], "selectedlanguageid" "r hes0bqtzmvil917efq5" }, "results" { "languages" \[ { "id" "grhuzddnydaiosqpb6388", "language" "200", "customlabel" "", "code" "{\n \\"transactionrequestid\\" \\"ji7abzpy 8xp3 gpby 2604 jab7tpxy36tp\\",\n \\"amount\\" 400,\n \\"transactionrequestedat\\" \\"2021 08 03t21 09 13 5882004z\\",\n \\"transactionstatus\\" \\"succeeded\\",\n \\"errordescription\\" null,\n \\"creditcardid\\" \\"kr7d47mnjil2r39oznrvpc0dis82es8je6j7vu\\",\n \\"railid\\" \\"tabapay\\",\n \\"network\\" \\"mastercard\\",\n \\"retrievalreferenceid\\" \\"8abcb1fa 51f1 4b2d 9998 5948877bdcc0\\",\n \\"actualtransactiondoneat\\" \\"2021 08 03t21 09 13 937108z\\",\n \\"requestapproved\\" true,\n \\"responsereceived\\" true,\n \\"responsecode\\" \\"00\\",\n \\"responsedescription\\" \\"approved\\",\n \\"tracenumber\\" \\"hl7a9zpg 8zpy 92po bhp2 xhpg5804pz2k\\",\n \\"error\\" null,\n \\"requestername\\" null,\n \\"requestermcc\\" null\n \\"issuccessful\\" true\n}" } ], "selectedlanguageid" "grhuzddnydaiosqpb6388" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "cardtoken", "kind" "optional", "type" "string", "description" "a randomly generated string of characters that relates to the consumer's payment card (15 38 alphanumeric characters) matches the creditcardtoken in the response ", "" "a randomly generated string of characters that relates to the consumer's payment card (15 38 alphanumeric characters) matches the creditcardtoken in the response " }, { "name" "statusenum", "kind" "optional", "type" "string", "description" "transaction status \n pending\n succeeded\n failed\n rejected", "" "transaction status \n pending\n succeeded\n failed\n rejected" }, { "name" "sourcesenderid", "kind" "optional", "type" "string", "description" "the guid that identifies the merchant partner", "" "the guid that identifies the merchant partner" }, { "name" "fromdate", "kind" "optional", "type" "string", "description" "report start date ", "" "report start date " }, { "name" "todate", "kind" "optional", "type" "string", "description" "report end date ", "" "report end date " } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "response" \[ { "name" "transactionrequestid", "kind" "optional", "type" "string", "description" "unique customer generated transaction request" }, { "name" "amount", "kind" "optional", "type" "integer", "description" "the amount to be transferred, in cents for example, 10001 = $100 01 ", "children" \[] }, { "name" "transactionrequestedat", "kind" "optional", "type" "string", "description" "date and time of the request (gmt)", "children" \[] }, { "name" "transactionstatus", "kind" "optional", "type" "string", "description" "transaction status \n\n pending\n succeeded\n failed\n rejected", "children" \[] }, { "name" "errordescription", "kind" "optional", "type" "string", "description" "a description of the error, if relevant", "children" \[] }, { "name" "creditcardid", "kind" "optional", "type" "string", "description" "card token of the signed up debit card", "children" \[] }, { "name" "railid", "kind" "optional", "type" "string", "description" "the payment processor used to perform the transaction \n\n rs2\n mcsend\n tabapay\n visa direct", "children" \[] }, { "name" "network", "kind" "optional", "type" "string", "description" "name of the payment card network", "children" \[] }, { "name" "retrievalreferenceid", "kind" "optional", "type" "string", "description" "the number cross river creates that is passed to the rail to assist in tracing a transaction after it left our system", "children" \[] }, { "name" "actualtransactiondoneat", "kind" "optional", "type" "string", "description" "the date and time the transaction was sent to the payment processor", "children" \[] }, { "name" "paymentsent", "kind" "optional", "type" "boolean", "description" "true if a payment was sent, otherwise false", "children" \[] }, { "name" "requestapproved", "kind" "optional", "type" "boolean", "description" "true if a request was approved, otherwise false", "children" \[] }, { "name" "responsereceived", "kind" "optional", "type" "boolean", "description" "true if a response was received, otherwise false", "children" \[] }, { "name" "responsecode", "kind" "optional", "type" "string", "description" "a 2 digit code signifying the transaction result (approved or decline) for example, 00 means successful ", "children" \[] }, { "name" "responsedescription", "kind" "optional", "type" "string", "description" "a string describing the transaction result for example, approved ", "children" \[] }, { "name" "tracenumber", "kind" "optional", "type" "string", "description" "a unique number assigned to a transaction from the time it leaves the merchant bank until it arrives at the cardholder bank", "children" \[] }, { "name" "error", "kind" "optional", "type" "string", "description" "a description of the error, if relevant", "children" \[] }, { "name" "sourcesendername", "kind" "optional", "type" "string", "description" "the name of the merchant this attribute (alphanumeric) identifies the sender of the funds ", "children" \[] }, { "name" "sourcemcc", "kind" "optional", "type" "string", "description" "merchant category code (mcc) 4 digits that a credit card issuer uses to categorize consumer transactions for their card ", "children" \[] }, { "name" "programid", "kind" "optional", "type" "string", "description" "connects a transaction to a given sub merchant network program id (visa mvv, mastercard mcid)", "children" \[] }, { "name" "businesstype", "kind" "optional", "type" "string", "description" " one of bb, fd, aa, pp, bi, cd, ft, wt, cp", "children" \[] } ] }