Request URL: https://sandbox-apigw.optum.com/pharmacynetwork/submitter/v1/pharmacy-claims
Submitter Request
"components": {
"schemas": {
"KeyValuePair": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"SubmitterRequest": {
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KeyValuePair"
}
},
"messageData": {
"type": "string"
}
}
},
The KeyValuePair object, formatted below, is for the Submitter Id and is required.
| Parameter | Description |
|---|---|
| name | The value for this field is submitterID |
| value | Enter the submitterID provided by Optum |
In some situations, a second KeyValuePair object is required for the Host Submitter ID, if applicable.
Note: Host Submitter ID is only used in specific cases. The implementation team will explain the use case during the implementation process if it is applicable.
| Parameter | Description |
|---|---|
| name | The value for this field is hostSubmitterID |
| value | Enter the hostSubmitterID provided by Optum |
The final piece of the Submitter Request is the messageData, which you must format based on the requirements of the receiving service.
| Parameter | Description |
|---|---|
| messageData | The D0/F6 format claim encoded in Base 64 format. |
Note: The Submitter API automatically adds the x-optum-trace-id header to the submitter Request message as a message-specific identification number. You do not need to enter anything.
If the Submitter API successfully forwards the Submitter Request to the Rx Connect, it returns a 200 success message, as shown below.
Success Response
{
"headers": [
{
"name": "string",
"value": "string"
}
],
"responseData": "string",
}
If the Submitter Request included both the Submitter ID and the Host Submitter ID, the success response includes a second set of name and value strings in the headers section.
NOTE
If the Submitter API rejects a transaction message or encounters an error before it sends the transaction to the appropriate services, it returns an error. For more information, see the Errors page linked below.