> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/api/api-endpoints/external-transaction/api-external-transaction-initial.md).

# /api/external‑transaction/initial

## POST /api/external-transaction/initial

> {% hint style="warning" %}\
> \*\*NOTICE:\*\* NATS Pro is required to use this API.\
> {% endhint %}\
> \
> Record an Initial Transaction

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/external-transaction/initial"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_external-transaction_initial":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["natscode","billerid","amount","currency","memberidx","transactionidx"]}}},"paths":{"/api/external-transaction/initial":{"post":{"description":"{% hint style=\"warning\" %}\n**NOTICE:** NATS Pro is required to use this API.\n{% endhint %}\n\nRecord an Initial Transaction","tags":["/api/external-transaction/initial"],"parameters":[{"name":"natscode","in":"query","schema":{"type":"string"},"required":true},{"name":"billerid","in":"query","schema":{"type":"integer"},"required":true},{"name":"amount","in":"query","schema":{"type":"string"},"required":true},{"name":"currency","in":"query","schema":{"type":"string"},"required":true},{"name":"memberidx","in":"query","schema":{"type":"string"},"required":true},{"name":"transactionidx","in":"query","schema":{"type":"string"},"required":true},{"name":"username","in":"query","schema":{"type":"string"},"required":false},{"name":"password","in":"query","schema":{"type":"string"},"required":false},{"name":"email","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_firstname","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_lastname","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_phone","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_address1","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_address2","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_city","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_state","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_zipcode","in":"query","schema":{"type":"string"},"required":false},{"name":"billing_country","in":"query","schema":{"type":"string"},"required":false},{"name":"shipping_firstname","in":"query","schema":{"type":"string"},"required":false},{"name":"shipping_lastname","in":"query","schema":{"type":"string"},"required":false},{"name":"shipping_address1","in":"query","schema":{"type":"string"},"required":false},{"name":"shipping_address2","in":"query","schema":{"type":"string"},"required":false},{"name":"shipping_zip","in":"query","schema":{"type":"string"},"required":false},{"name":"shipping_city","in":"query","schema":{"type":"string"},"required":false},{"name":"shipping_country","in":"query","schema":{"type":"string"},"required":false},{"name":"shipping_state","in":"query","schema":{"type":"string"},"required":false},{"name":"option_identifier","in":"query","schema":{"type":"string"},"required":false},{"name":"ip","in":"query","schema":{"type":"string"},"required":false},{"name":"country","in":"query","schema":{"type":"string"},"required":false},{"name":"landing_page_url","in":"query","schema":{"type":"string"},"required":false},{"name":"referring_url","in":"query","schema":{"type":"string"},"required":false},{"name":"ptype","in":"query","schema":{"type":"string"},"required":false},{"name":"custom1","in":"query","schema":{"type":"string"},"required":false},{"name":"custom2","in":"query","schema":{"type":"string"},"required":false},{"name":"custom3","in":"query","schema":{"type":"string"},"required":false},{"name":"custom4","in":"query","schema":{"type":"string"},"required":false},{"name":"custom5","in":"query","schema":{"type":"string"},"required":false},{"name":"custom6","in":"query","schema":{"type":"string"},"required":false},{"name":"custom7","in":"query","schema":{"type":"string"},"required":false},{"name":"custom8","in":"query","schema":{"type":"string"},"required":false},{"name":"custom9","in":"query","schema":{"type":"string"},"required":false},{"name":"custom10","in":"query","schema":{"type":"string"},"required":false},{"name":"transaction_passthrough1","in":"query","schema":{"type":"string"},"required":false},{"name":"transaction_passthrough2","in":"query","schema":{"type":"string"},"required":false},{"name":"transaction_passthrough3","in":"query","schema":{"type":"string"},"required":false},{"name":"transaction_passthrough4","in":"query","schema":{"type":"string"},"required":false},{"name":"transaction_passthrough5","in":"query","schema":{"type":"string"},"required":false},{"name":"memberid","in":"query","schema":{"type":"integer"},"required":false},{"name":"optionid","in":"query","schema":{"type":"integer"},"required":false},{"name":"custom_lookup_id","in":"query","schema":{"type":"integer"},"required":false},{"name":"landing_page_lookup_id","in":"query","schema":{"type":"integer"},"required":false},{"name":"refurl_lookup_id","in":"query","schema":{"type":"integer"},"required":false},{"name":"loginid","in":"query","schema":{"type":"integer"},"required":false},{"name":"programid","in":"query","schema":{"type":"integer"},"required":false},{"name":"siteid","in":"query","schema":{"type":"integer"},"required":false},{"name":"tourid","in":"query","schema":{"type":"integer"},"required":false},{"name":"campaignid","in":"query","schema":{"type":"integer"},"required":false},{"name":"adtoolid","in":"query","schema":{"type":"integer"},"required":false},{"name":"subid1","in":"query","schema":{"type":"integer"},"required":false},{"name":"subid2","in":"query","schema":{"type":"integer"},"required":false},{"name":"promotionalid","in":"query","schema":{"type":"integer"},"required":false},{"name":"time","in":"query","schema":{"type":"integer"},"required":false},{"name":"expire_time","in":"query","schema":{"type":"integer"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_external-transaction_initial"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_external-transaction_initial"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_external-transaction_initial"}}}}}}}}}
```